Fix javadocs and enable doclint

This eliminates the doclint suppression and fixes up javadoc, so they
work with Java 8 out of the box.

Change-Id: I7294f0dcd570e3e3c445e54cc8989078175d05d7
Signed-off-by: Robert Varga <rovarga@cisco.com>

diff --git a/pom.xml b/pom.xml
index b97be83fe6a89a2db9e1f9541694ca85c2e4ce43..e6029f77d024e9c599b824f616cfac6d484d440e 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -114,27 +114,6 @@
     </plugins>
   </build>
 
-  <profiles>
-    <!-- Turn off doclint. -->
-    <profile>
-      <id>jdk8</id>
-      <activation>
-        <jdk>[1.8,)</jdk>
-      </activation>
-      <build>
-        <plugins>
-          <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-javadoc-plugin</artifactId>
-            <configuration>
-              <additionalparam>-Xdoclint:none</additionalparam>
-            </configuration>
-          </plugin>
-        </plugins>
-      </build>
-    </profile>
-  </profiles>
-
   <scm>
     <connection>scm:git:http://git.opendaylight.org/gerrit/controller.git</connection>
     <developerConnection>scm:git:ssh://git.opendaylight.org:29418/controller.git</developerConnection>

diff --git a/src/main/java/org/opendaylight/protocol/framework/AbstractDispatcher.java b/src/main/java/org/opendaylight/protocol/framework/AbstractDispatcher.java
index 334ccc2cc37555eef73488a013ae182e4b3d8b38..e153861eb802527d0beed9a2743105cd8e502152 100644 (file)
--- a/src/main/java/org/opendaylight/protocol/framework/AbstractDispatcher.java
+++ b/src/main/java/org/opendaylight/protocol/framework/AbstractDispatcher.java
@@ -147,7 +147,7 @@ public abstract class AbstractDispatcher<S extends ProtocolSession<?>, L extends
      * Creates a client.
      *
      * @param address remote address
-     * @param connectStrategy Reconnection strategy to be used when initial connection fails
+     * @param strategy Reconnection strategy to be used when initial connection fails
      *
      * @return Future representing the connection process. Its result represents the combined success of TCP connection
      *         as well as session negotiation.
@@ -266,7 +266,7 @@ public abstract class AbstractDispatcher<S extends ProtocolSession<?>, L extends
     }
 
     /**
-     * @deprecated Should only be used with {@link AbstractDispatcher#AbstractDispatcher()}
+     * @deprecated Should only be used with AbstractDispatcher#AbstractDispatcher()
      */
     @Deprecated
     @Override

diff --git a/src/main/java/org/opendaylight/protocol/framework/AbstractSessionNegotiator.java b/src/main/java/org/opendaylight/protocol/framework/AbstractSessionNegotiator.java
index 8a19828c578d21b5a29b0c6ca14ddbea5831b889..ddd10d2ce5921c5c9e4d7ea0cf90c32b69739919 100644 (file)
--- a/src/main/java/org/opendaylight/protocol/framework/AbstractSessionNegotiator.java
+++ b/src/main/java/org/opendaylight/protocol/framework/AbstractSessionNegotiator.java
@@ -25,7 +25,7 @@ import com.google.common.base.Preconditions;
  * needing to provide only
  *
  * @param <M> Protocol message type
- * @param <S> Protocol session type, has to extend ProtocolSession<M>
+ * @param <S> Protocol session type, has to extend {@code ProtocolSession<M>}
  */
 @Deprecated
 public abstract class AbstractSessionNegotiator<M, S extends AbstractProtocolSession<?>> extends ChannelInboundHandlerAdapter implements SessionNegotiator<S> {

diff --git a/src/main/java/org/opendaylight/protocol/framework/SessionListener.java b/src/main/java/org/opendaylight/protocol/framework/SessionListener.java
index dfe0208c54b33156892843bf961c0e0ad6aafd6c..06b27307308b18c2fbb58a7700c28dfbbea36c6e 100644 (file)
--- a/src/main/java/org/opendaylight/protocol/framework/SessionListener.java
+++ b/src/main/java/org/opendaylight/protocol/framework/SessionListener.java
@@ -19,7 +19,7 @@ public interface SessionListener<M, S extends ProtocolSession<?>, T extends Term
     /**
      * Fired when the session was established successfully.
      *
-     * @param remoteParams Peer address families which we accepted
+     * @param session New session
      */
     void onSessionUp(S session);
 

diff --git a/src/main/java/org/opendaylight/protocol/framework/TimedReconnectStrategy.java b/src/main/java/org/opendaylight/protocol/framework/TimedReconnectStrategy.java
index ecb9e65a528a104f0e7727f45e65f97d9e583c44..ed60abb05adb9f25e92fe751a4e8162c531da458 100644 (file)
--- a/src/main/java/org/opendaylight/protocol/framework/TimedReconnectStrategy.java
+++ b/src/main/java/org/opendaylight/protocol/framework/TimedReconnectStrategy.java
@@ -29,7 +29,7 @@ import com.google.common.base.Preconditions;
  *
  * Initial sleep time is specified as minSleep. Each subsequent unsuccessful attempt multiplies this time by a constant
  * factor (sleepFactor) -- this allows for either constant reconnect times (sleepFactor = 1), or various degrees of
- * exponential back-off (sleepFactor > 1). Maximum sleep time between attempts can be capped to a specific value
+ * exponential back-off (sleepFactor > 1). Maximum sleep time between attempts can be capped to a specific value
  * (maxSleep).
  *
  * The strategy can optionally give up based on two criteria: