Merge "BUG-576: fixed javadoc warnings."
authorTony Tkacik <ttkacik@cisco.com>
Mon, 25 Aug 2014 10:19:22 +0000 (10:19 +0000)
committerGerrit Code Review <gerrit@opendaylight.org>
Mon, 25 Aug 2014 10:19:22 +0000 (10:19 +0000)
yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/AugmentationSchemaBuilder.java
yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/ConstraintsBuilder.java
yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/RefineBuilder.java
yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/TypeDefinitionBuilder.java
yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/UnknownSchemaNodeBuilder.java
yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/impl/BuilderUtils.java
yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/ParserListenerUtils.java
yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/YangParserListenerImpl.java

index 1699da75abf9d9516cf156d9bbe0fd8d33f934be..f7004791e2c1d21da4fd77970c28438bfdd5f588 100644 (file)
@@ -19,13 +19,11 @@ public interface AugmentationSchemaBuilder extends DataNodeContainerBuilder,Docu
      * Returns when condition
      *
      * If when condition is present node defined by the parent data definition
-     * statement is only valid when the returned XPath
-     * expression conceptually evaluates to "true"
-     * for a particular instance, then the node defined by the parent data
-     * definition statement is valid; otherwise, it is not.
-     *
+     * statement is only valid when the returned XPath expression conceptually
+     * evaluates to "true" for a particular instance, then the node defined by
+     * the parent data definition statement is valid; otherwise, it is not.
      *
-     * @return
+     * @return when condition as string
      */
     String getWhenCondition();
 
index 196b49deb25a4736bbafd5a09a286ba8025edff4..e122e5978fbec50546e5f57df7461c4ae21d65b2 100644 (file)
@@ -65,7 +65,7 @@ public interface ConstraintsBuilder extends Builder<ConstraintDefinition> {
      *
      * This constraint has meaning only if associated node is list or leaf-list.
      *
-     * @param minElements
+     * @param maxElements
      *            number of maximum required elements.
      */
     void setMaxElements(Integer maxElements);
@@ -119,7 +119,7 @@ public interface ConstraintsBuilder extends Builder<ConstraintDefinition> {
     /**
      * Build constraint definition
      *
-     * @return
+     * @return instance of ConstraintDefinition created from this builder
      */
     ConstraintDefinition toInstance();
 
index 183f9fd05c62d8a19ab451188576cdfee6f29bc0..89237986586239bd6339692db77c379f1645b2f9 100644 (file)
@@ -106,7 +106,7 @@ public interface RefineBuilder extends DocumentedNodeBuilder {
    *
    * This constraint has meaning only if associated node is list or leaf-list.
    *
-   * @param minElements number of maximum required elements.
+   * @param maxElements number of maximum required elements.
    */
    void setMaxElements(Integer maxElements);
 
index e547d440fa9cf8c90f6d0761006bae90fb100162..068130fbf80ddfd4363a59d2ce447f08cc4cd89f 100644 (file)
@@ -69,10 +69,10 @@ public interface TypeDefinitionBuilder extends TypeAwareBuilder, SchemaNodeBuild
     List<PatternConstraint> getPatterns();
 
     /**
-     * Set length restrictions for resulting type definition.
+     * Set pattern restrictions for resulting type definition.
      *
-     * @param lengths
-     *            Length restrictions of resulting type definition.
+     * @param patterns
+     *            patterns restrictions of resulting type definition.
      */
     void setPatterns(List<PatternConstraint> patterns);
 
@@ -86,11 +86,8 @@ public interface TypeDefinitionBuilder extends TypeAwareBuilder, SchemaNodeBuild
     Integer getFractionDigits();
 
     /**
-     *
-     * Sets fractions digits of resulting type if it is derived
-     * from <code>decimal</code> built-in type.
-     *
-     * @return fractions digits of resulting type
+     * Sets fractions digits of resulting type if it is derived from
+     * <code>decimal</code> built-in type.
      */
     void setFractionDigits(Integer fractionDigits);
 
index 3b0cb966cd0ba3873a5145166e390d2a1fad8209..433c0821c02f850fe0532269b0fa94699acd3d77 100644 (file)
@@ -72,7 +72,9 @@ public interface UnknownSchemaNodeBuilder extends SchemaNodeBuilder, DocumentedN
 
     /**
      * Sets extension builder, which declares this unknown node
-     * @param extensionBuilder extension definition, which declares this unknown node
+     *
+     * @param extension
+     *            extension builder, which declares this unknown node
      */
     void setExtensionBuilder(ExtensionBuilder extension);
 
index 4a61d7b0f6d0eef9458a16fbc1c3becd97d3976c..c7ebf66d2d3195fa9bcc7f5d7dba2cba3467cbfe 100644 (file)
@@ -20,8 +20,6 @@ import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URI;
-import java.text.DateFormat;
-import java.text.SimpleDateFormat;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Date;
@@ -78,9 +76,7 @@ import org.slf4j.LoggerFactory;
 
 public final class BuilderUtils {
 
-    private static final DateFormat SIMPLE_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd");
     private static final Logger LOG = LoggerFactory.getLogger(BuilderUtils.class);
-    private static final Splitter SLASH_SPLITTER = Splitter.on('/').omitEmptyStrings();
     private static final Splitter COLON_SPLITTER = Splitter.on(':');
     private static final Date NULL_DATE = new Date(0L);
     private static final String INPUT = "input";
@@ -473,7 +469,7 @@ public final class BuilderUtils {
      *            Class to be checked
      * @param optional
      *            Original value
-     * @return
+     * @return Optional object with type argument casted as cls
      */
     private static <T> Optional<T> castOptional(final Class<T> cls, final Optional<?> optional) {
         if (optional.isPresent()) {
@@ -635,10 +631,9 @@ public final class BuilderUtils {
      * Find augment target node and perform augmentation.
      *
      * @param augment
+     *            augment builder to process
      * @param firstNodeParent
      *            parent of first node in path
-     * @param path
-     *            path to augment target
      * @return true if augmentation process succeed, false otherwise
      */
     public static boolean processAugmentation(final AugmentationSchemaBuilder augment,
index 57f1cc963519ef230b14f53e429223329995e748..933ac6b6d4f17f489efb3fa878ea868bbf7bfb94 100644 (file)
@@ -1091,12 +1091,8 @@ public final class ParserListenerUtils {
      *            type body context
      * @param actualPath
      *            current path in schema
-     * @param namespace
-     *            current namespace
-     * @param revision
-     *            current revision
-     * @param prefix
-     *            current prefix
+     * @param moduleQName
+     *            current module qname
      * @param parent
      *            parent builder
      * @return TypeDefinition object based on parsed values.
index 6e412953c3d93d71a708a1fbddc8fd6acb19a391..9de7ce02b4fa5b077b642d1e5214db151b4c7f12 100644 (file)
@@ -127,14 +127,14 @@ public final class YangParserListenerImpl extends YangParserBaseListener {
      * Create a new instance.
      *
      * FIXME: the resulting type needs to be extracted, such that we can reuse
-     *        the "BaseListener" aspect, which need not be exposed to the user.
-     *        Maybe factor out a base class into repo.spi?
+     * the "BaseListener" aspect, which need not be exposed to the user. Maybe
+     * factor out a base class into repo.spi?
      *
      * @param namespaceContext
      * @param sourcePath
      * @param walker
      * @param tree
-     * @return
+     * @return new instance of YangParserListenerImpl
      */
     public static YangParserListenerImpl create(final Map<String, TreeMap<Date, URI>> namespaceContext,
             final String sourcePath, final ParseTreeWalker walker, final ParseTree tree) {