Merge "Fix javadoc warnings in common concepts"

diff --git a/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Builder.java b/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Builder.java
index affc25b7713f98c759d06b45ef5c53275074f69f..0484c4831e86b81bcf7ebf408049dcdcc135d3e3 100644 (file)
--- a/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Builder.java
+++ b/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Builder.java
@@ -12,7 +12,7 @@ package org.opendaylight.yangtools.concepts;
  * 
  * @param <P> Product of builder
  * 
- * @author Tony Tkacik <ttkacik@cisco.com>
+ * @author Tony Tkacik &lt;ttkacik@cisco.com&gt;
  */
 public interface Builder<P> extends Mutable {
     
@@ -22,7 +22,7 @@ public interface Builder<P> extends Mutable {
      * Multiple calls to this method are not required to return
      * same instance if the state of the builder was changed.
      * 
-     * @return
+     * @return Newly-built instance
      */
     P toInstance();
 }

diff --git a/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/ClassBasedPropertyBuilder.java b/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/ClassBasedPropertyBuilder.java
index 35187ba167ab9ad9ff0b11965ec6f68fa8f7f5c1..85016b8e10835f4b172a3d8d75445a0642e0a2fd 100644 (file)
--- a/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/ClassBasedPropertyBuilder.java
+++ b/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/ClassBasedPropertyBuilder.java
@@ -10,21 +10,20 @@ package org.opendaylight.yangtools.concepts;
 public interface ClassBasedPropertyBuilder<P,T extends ClassBasedPropertyBuilder<P,T>> extends Builder<P> {
 
     /**
-     * Sets a value of property uniquely identified by it's
+     * Sets a value of property uniquely identified by its
      * class.
      * 
      * @param type Type of property to set
      * @param value Value of property 
-     * @return
+     * @return Builder instance
      */
-    <V> T set(Class<V> type,V value);
+    <V> T set(Class<V> type, V value);
     
     /**
-     * Gets a value of property based on it's type.
+     * Gets a value of property based on its type.
      * 
-     * @param type
-     * @return
+     * @param type Type of property to get
+     * @return Builder instance
      */
     <V> V get(Class<V> type);
-
 }

diff --git a/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/ProductAwareBuilder.java b/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/ProductAwareBuilder.java
index b2c2d049e0c70dcfedf1e8c672c079cfd74d2fc2..184e467d443c967ce2c7ae553e606184b59dc935 100644 (file)
--- a/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/ProductAwareBuilder.java
+++ b/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/ProductAwareBuilder.java
@@ -17,7 +17,7 @@ package org.opendaylight.yangtools.concepts;
 public interface ProductAwareBuilder<P> extends Builder<P> {
        /**
         * Return the hash code of the product. This has to be equivalent
-        * of calling {@link #toInstance()}.{@link #hashCode()}.
+        * of calling {@link #toInstance()}.{@link Object#hashCode()}.
         *
         * @return the hash code of the product.
         */
@@ -26,7 +26,7 @@ public interface ProductAwareBuilder<P> extends Builder<P> {
        /**
         * Check whether an instance of the product that would be created
         * by the builder is equal to an existing instance. This has to
-        * be equivalent of calling {@link #toInstance()}.{@link #equals(Object)}.
+        * be equivalent of calling {@link #toInstance()}.{@link Object#equals(Object)}.
         *
         * @param product Product instance
         * @return Return true if the product is equal to the would-be