Fix checkstyle in javadocs

Updated checkstyle is catching more violations, fix them up.

Change-Id: I1048fea86966113184fe49fe707d6d0d328c3508
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/RpcConsumerRegistry.java b/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/RpcConsumerRegistry.java
index 10c13cf19d793a61ad9c3a8d242a8816bf0e236e..9dc24ce26add202ca092a7bfafe887991a7b11a4 100644 (file)
--- a/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/RpcConsumerRegistry.java
+++ b/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/RpcConsumerRegistry.java
@@ -36,7 +36,6 @@ public interface RpcConsumerRegistry extends BindingService {
      * <li>Prior to invoking the actual implementation, the method arguments are are validated. If
      * any are invalid, an {@link IllegalArgumentException} is thrown.
      * </ul>
-     *
      * The returned proxy is automatically updated with the most recent registered implementation.
      *
      * <p>

diff --git a/binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/api/BindingDataObjectCodecTreeNode.java b/binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/api/BindingDataObjectCodecTreeNode.java
index 9f8efd559de76448420bdca277ef6ed3a0b0a9a1..9853bf746464b8cc92f29d9359a74caf63226476 100644 (file)
--- a/binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/api/BindingDataObjectCodecTreeNode.java
+++ b/binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/api/BindingDataObjectCodecTreeNode.java
@@ -37,7 +37,7 @@ public interface BindingDataObjectCodecTreeNode<T extends DataObject> extends Bi
      * Returns child context as if it was walked by {@link BindingStreamEventWriter}. This means that to enter case,
      * one must issue getChild(ChoiceClass).getChild(CaseClass).
      *
-     * @param childClass Child class by Biding Stream navigation
+     * @param childClass Child class by Binding Stream navigation
      * @return Context of child
      * @throws IllegalArgumentException
      *             If supplied child class is not valid in specified context.
@@ -53,7 +53,7 @@ public interface BindingDataObjectCodecTreeNode<T extends DataObject> extends Bi
      * augmentation and cases, that may return {@link BindingCodecTreeNode} even if augmentation interface containing
      * same data was supplied and does not represent augmentation of this node.
      *
-     * @param childClass
+     * @param childClass Child class by Binding Stream navigation
      * @return Context of child or Optional.empty is supplied class is not
      *         applicable in context.
      */

diff --git a/binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/binding/model/api/pkg-info.java b/binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/binding/model/api/pkg-info.java
index 9c61fe1503f4ff326088a9a6ecf700fad20fcce0..0b461e69d0735c2197af81999a3bc5c033451878 100644 (file)
--- a/binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/binding/model/api/pkg-info.java
+++ b/binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/binding/model/api/pkg-info.java
@@ -6,7 +6,7 @@
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
 /**
- * Some information on naming:
+ * Model of Java classes generated from YANG. Some information on naming:
  *
  * <ul>
  * <li>

diff --git a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingStreamEventWriter.java b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingStreamEventWriter.java
index 2d6ed5cba7889aec5d9a46442d9eaf088758f532..d6aeb8a5e9aecc2b3bcae3c72b47fb53842a3cd7 100644 (file)
--- a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingStreamEventWriter.java
+++ b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingStreamEventWriter.java
@@ -271,6 +271,8 @@ public interface BindingStreamEventWriter extends Closeable, Flushable {
      *            and should not fail writing of child events, if there are more
      *            events than count.
      * @throws IllegalArgumentException
+     *             If emitted node is invalid in current context or was emitted
+     *             multiple times.
      * @throws IllegalStateException
      *             If node was emitted inside <code>map</code>,
      *             <code>choice</code> <code>unkeyed list</code> node.
@@ -295,6 +297,8 @@ public interface BindingStreamEventWriter extends Closeable, Flushable {
      *            and should not fail writing of child events, if there are more
      *            events than count.
      * @throws IllegalArgumentException
+     *             If emitted node is invalid in current context or was emitted
+     *             multiple times.
      * @throws IllegalStateException
      *             If node was emitted inside <code>map</code>,
      *             <code>choice</code> <code>unkeyed list</code> node.

diff --git a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/InstanceIdentifier.java b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/InstanceIdentifier.java
index cf69f763d9c124ce471afa609f6fac8618879e32..8627422ee753f926f43654ea83c90b81e7d5cdf0 100644 (file)
--- a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/InstanceIdentifier.java
+++ b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/InstanceIdentifier.java
@@ -810,16 +810,14 @@ public class InstanceIdentifier<T extends DataObject> implements Path<InstanceId
 
     public interface InstanceIdentifierBuilder<T extends DataObject> extends Builder<InstanceIdentifier<T>> {
         /**
-         * Append the specified container as a child of the current InstanceIdentifier referenced by the builder.
-         *
-         * This method should be used when you want to build an instance identifier by appending top-level
-         * elements
-         *
-         * Example,
+         * Append the specified container as a child of the current InstanceIdentifier referenced by the builder. This
+         * method should be used when you want to build an instance identifier by appending top-level elements, for
+         * example
          * <pre>
          *     InstanceIdentifier.builder().child(Nodes.class).build();
          * </pre>
          *
+         * <p>
          * NOTE :- The above example is only for illustration purposes InstanceIdentifier.builder() has been deprecated
          * and should not be used. Use InstanceIdentifier.builder(Nodes.class) instead
          *
@@ -831,11 +829,9 @@ public class InstanceIdentifier<T extends DataObject> implements Path<InstanceId
         <N extends ChildOf<? super T>> @NonNull InstanceIdentifierBuilder<N> child(Class<N> container);
 
         /**
-         * Append the specified container as a child of the current InstanceIdentifier referenced by the builder.
-         *
-         * This method should be used when you want to build an instance identifier by appending a container node
-         * to the identifier and the {@code container} is defined in a {@code grouping} used in a {@code case}
-         * statement.
+         * Append the specified container as a child of the current InstanceIdentifier referenced by the builder. This
+         * method should be used when you want to build an instance identifier by appending a container node to the
+         * identifier and the {@code container} is defined in a {@code grouping} used in a {@code case} statement.
          *
          * @param caze Choice case class
          * @param container Container to append
@@ -848,10 +844,9 @@ public class InstanceIdentifier<T extends DataObject> implements Path<InstanceId
                 @NonNull InstanceIdentifierBuilder<N> child(Class<C> caze, Class<N> container);
 
         /**
-         * Append the specified listItem as a child of the current InstanceIdentifier referenced by the builder.
-         *
-         * This method should be used when you want to build an instance identifier by appending a specific list element
-         * to the identifier
+         * Append the specified listItem as a child of the current InstanceIdentifier referenced by the builder. This
+         * method should be used when you want to build an instance identifier by appending a specific list element to
+         * the identifier.
          *
          * @param listItem List to append
          * @param listKey List key
@@ -864,10 +859,9 @@ public class InstanceIdentifier<T extends DataObject> implements Path<InstanceId
                 @NonNull InstanceIdentifierBuilder<N> child(Class<N> listItem, K listKey);
 
         /**
-         * Append the specified listItem as a child of the current InstanceIdentifier referenced by the builder.
-         *
-         * This method should be used when you want to build an instance identifier by appending a specific list element
-         * to the identifier and the {@code list} is defined in a {@code grouping} used in a {@code case} statement.
+         * Append the specified listItem as a child of the current InstanceIdentifier referenced by the builder. This
+         * method should be used when you want to build an instance identifier by appending a specific list element to
+         * the identifier and the {@code list} is defined in a {@code grouping} used in a {@code case} statement.
          *
          * @param caze Choice case class
          * @param listItem List to append