From 0be23766976cc7ede23f99773627ceed20aa1cce Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Sun, 12 Oct 2014 13:51:36 +0200 Subject: [PATCH] Fix javadoc warnings in common concepts This is a cleanup of warnings currently reported. Change-Id: I6a7103fbfe8ccf0d94067924cb46489f8c53d29b Signed-off-by: Robert Varga --- .../opendaylight/yangtools/concepts/Builder.java | 4 ++-- .../concepts/ClassBasedPropertyBuilder.java | 13 ++++++------- .../yangtools/concepts/ProductAwareBuilder.java | 4 ++-- 3 files changed, 10 insertions(+), 11 deletions(-) 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 affc25b771..0484c4831e 100644 --- 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

Product of builder * - * @author Tony Tkacik + * @author Tony Tkacik <ttkacik@cisco.com> */ public interface Builder

extends Mutable { @@ -22,7 +22,7 @@ public interface Builder

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 35187ba167..85016b8e10 100644 --- 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> extends Builder

{ /** - * 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 */ - T set(Class type,V value); + T set(Class 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 get(Class 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 b2c2d049e0..184e467d44 100644 --- 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

extends Builder

{ /** * 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

extends Builder

{ /** * 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 -- 2.36.6