Fixed some java8 non-compliant javadocs.

Change-Id: I4c067a1466f6373d1e3d6f1582dfb13af5775a40
Signed-off-by: Dana Kutenicsova <dkutenic@cisco.com>

diff --git a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/StrictBGPPeerRegistry.java b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/StrictBGPPeerRegistry.java
index a3960a606e3a7cbb0c4fe7ec09f868a62657d50c..1e997a9c16ec4ace97585fcf9cbe2056745a3028 100644 (file)
--- a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/StrictBGPPeerRegistry.java
+++ b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/StrictBGPPeerRegistry.java
@@ -170,6 +170,7 @@ public final class StrictBGPPeerRegistry implements BGPPeerRegistry {
      * Creates IpAddress from SocketAddress. Only InetSocketAddress is accepted with inner address: Inet4Address and Inet6Address.
      *
      * @param socketAddress socket address to transform
+     * @return IpAddress equivalent to given socket address
      * @throws IllegalArgumentException if submitted socket address is not InetSocketAddress[ipv4 | ipv6]
      */
     public static IpAddress getIpAddress(final SocketAddress socketAddress) {

diff --git a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/BGPDispatcher.java b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/BGPDispatcher.java
index 6f9f7f32d7a91dc1802a223c6c60b8f0ca9315d0..91a43fb1d1d1ec58f2d48dce26474435fb4a61a0 100644 (file)
--- a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/BGPDispatcher.java
+++ b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/BGPDispatcher.java
@@ -33,11 +33,27 @@ public interface BGPDispatcher{
     Future<? extends BGPSession> createClient(InetSocketAddress address, AsNumber remoteAs,
             BGPPeerRegistry peerRegistry, ReconnectStrategy strategy);
 
+    /**
+     * Creates Reconnecting client.
+     *
+     * @param address Peer address
+     * @param remoteAs remote AS
+     * @param peerRegistry BGP peer registry
+     * @param connectStrategyFactory reconnection strategy
+     * @param keys for TCPMD5
+     * @return Future promising a client session
+     */
     Future<Void> createReconnectingClient(InetSocketAddress address, AsNumber remoteAs,
                                           BGPPeerRegistry peerRegistry, ReconnectStrategyFactory connectStrategyFactory, KeyMapping keys);
 
     /**
      * Create new BGP server to accept incoming bgp connections (bound to provided socket address).
+     *
+     * @param peerRegistry BGP peer registry
+     * @param address Peer address
+     * @param sessionValidator BGPSessionValidator
+     *
+     * @return ChannelFuture promising a client session
      */
     ChannelFuture createServer(BGPPeerRegistry peerRegistry, InetSocketAddress address, BGPSessionValidator sessionValidator);
 }

diff --git a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/BGPPeerRegistry.java b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/BGPPeerRegistry.java
index ccd500801235a009cdfeff6bbe569901cec0491e..80a522b785b6eef0f27599fde598b633927dffcb 100644 (file)
--- a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/BGPPeerRegistry.java
+++ b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/BGPPeerRegistry.java
@@ -57,8 +57,8 @@ public interface BGPPeerRegistry extends AutoCloseable {
      * @param ip address of remote peer
      * @param sourceId BGP ID of peer that initiated the session (current device or remote peer)
      * @param remoteId BGP ID of peer that accepted the session (current device or remote peer)
-     * @param asNumber id of the AS
-     * @return configured Peer as BGP listener
+     * @param asNumber remote AS number
+     * @return BGPSessionListener configured Peer as BGP listener
      *
      * @throws BGPDocumentedException if session establishment cannot be finished successfully
      * @throws java.lang.IllegalStateException if there is no peer configured for provided ip address

diff --git a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/BGPServerDispatcher.java b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/BGPServerDispatcher.java
index 9c05bf13f3dfb6f66e3041a5320910e1ab19b4ef..80e01c2d8f2d4c302b61fc84ab96f6ee40b2e45e 100644 (file)
--- a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/BGPServerDispatcher.java
+++ b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/BGPServerDispatcher.java
@@ -16,10 +16,24 @@ import org.opendaylight.tcpmd5.api.KeyMapping;
  */
 public interface BGPServerDispatcher {
 
+    /**
+     * Create new BGP server to accept incoming bgp connections (bound to provided socket address).
+     *
+     * @param peerRegistry BGP peer registry
+     * @param address server address
+     * @param sessionValidator BGPSessionValidator
+     * @return ChannelFuture promising a server session
+     */
     ChannelFuture createServer(BGPPeerRegistry peerRegistry, InetSocketAddress address, BGPSessionValidator sessionValidator);
 
     /**
      * Create new BGP server to accept incoming bgp connections (bound to provided socket address).
+     *
+     * @param peerRegistry BGP peer registry
+     * @param address server address
+     * @param sessionValidator BGPSessionValidator
+     * @param keys KeyMapping
+     * @return ChannelFuture promising a server session
      */
     ChannelFuture createServer(BGPPeerRegistry peerRegistry, InetSocketAddress address, BGPSessionValidator sessionValidator, KeyMapping keys);
 }

diff --git a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/RIBSupportContext.java b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/RIBSupportContext.java
index 1019be271e8dedaed00910ff1a34bb6ded0c09b8..9c25bdaf19b4d2a48d8a2c2b02fce69a38a3ab0f 100644 (file)
--- a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/RIBSupportContext.java
+++ b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/RIBSupportContext.java
@@ -57,7 +57,7 @@ public abstract class RIBSupportContext {
     /**
      * Returns backing RIB support.
      *
-     * @return
+     * @return RIBSupport
      */
     public abstract RIBSupport getRibSupport();
 }