From 3bd4809550761e88b572ef87fb16d926d06659ca Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Tue, 6 Aug 2019 13:29:45 +0200 Subject: [PATCH] Fix checkstyle in javadocs Updated checkstyle is catching more violations, fix them up. Change-Id: I1048fea86966113184fe49fe707d6d0d328c3508 Signed-off-by: Robert Varga --- .../binding/api/RpcConsumerRegistry.java | 1 - .../api/BindingDataObjectCodecTreeNode.java | 4 +-- .../mdsal/binding/model/api/pkg-info.java | 2 +- .../binding/BindingStreamEventWriter.java | 4 +++ .../yang/binding/InstanceIdentifier.java | 32 ++++++++----------- 5 files changed, 20 insertions(+), 23 deletions(-) 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 10c13cf19d..9dc24ce26a 100644 --- 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 { *
  • Prior to invoking the actual implementation, the method arguments are are validated. If * any are invalid, an {@link IllegalArgumentException} is thrown. * - * * The returned proxy is automatically updated with the most recent registered implementation. * *

    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 9f8efd559d..9853bf7464 100644 --- 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 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 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 9c61fe1503..0b461e69d0 100644 --- 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: * *

      *
    • 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 2d6ed5cba7..d6aeb8a5e9 100644 --- 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 map, * choice unkeyed list 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 map, * choice unkeyed list 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 cf69f763d9..8627422ee7 100644 --- 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 implements Path extends Builder> { /** - * 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 * 
                *     InstanceIdentifier.builder().child(Nodes.class).build();
          *
      * + *

      * 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 implements Path> @NonNull InstanceIdentifierBuilder child(Class 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 implements Path child(Class caze, Class 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 implements Path child(Class 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 -- 2.36.6