Clarify GeneratedTransferObject.getSuperType()

The Javadoc for this method is confusing and actually misleading.
Clarify it a bit for future's sake.

Change-Id: I52f09e2e9cf864dc00fb4883099ca4df5219327f
Signed-off-by: Robert Varga <rovarga@cisco.com>

diff --git a/code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/sal/binding/model/api/GeneratedTransferObject.java b/code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/sal/binding/model/api/GeneratedTransferObject.java
index 32130d1cb77ebe06f0abdfee4d2db6cf91459794..f96ade0f411c73d76f6d8fd20a23a72683c43129 100644 (file)
--- a/code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/sal/binding/model/api/GeneratedTransferObject.java
+++ b/code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/sal/binding/model/api/GeneratedTransferObject.java
@@ -28,11 +28,12 @@ public interface GeneratedTransferObject extends GeneratedType {
     GeneratedProperty getSUID();
 
     /**
-     * Returns the extending Generated Transfer Object or <code>null</code> if
-     * there is no extending Generated Transfer Object.
+     * Returns the Generated Transfer Object from which this GTO is derived, or
+     * null if this GTO is not derived from a GTO -- e.g. it is either an union
+     * or it is derived from a concrete type.
      *
-     * @return the extending Generated Transfer Object or <code>null</code> if
-     *         there is no extending Generated Transfer Object.
+     * @return Generated Transfer Object or <code>null</code> if this GTO is
+     *         not derived from another GTO.
      */
     GeneratedTransferObject getSuperType();
 
@@ -70,7 +71,7 @@ public interface GeneratedTransferObject extends GeneratedType {
      *
      * @return Base type of Java representation of YANG typedef if set, otherwise it returns null
      */
-    TypeDefinition getBaseType();
+    TypeDefinition<?> getBaseType();
 
     /**
      * Return boolean value which describe whether Generated Transfer Object