MDSAL-301: Binding v2 - Rework javadoc generation

[mdsal.git] / binding2 / mdsal-binding2-generator-api / src / main / java / org / opendaylight / mdsal / binding / javav2 / model / api / GeneratedType.java

diff --git a/binding2/mdsal-binding2-generator-api/src/main/java/org/opendaylight/mdsal/binding/javav2/model/api/GeneratedType.java b/binding2/mdsal-binding2-generator-api/src/main/java/org/opendaylight/mdsal/binding/javav2/model/api/GeneratedType.java
old mode 100644 (file)
new mode 100755 (executable)
index 0d1d61e..c37fbd0
--- a/binding2/mdsal-binding2-generator-api/src/main/java/org/opendaylight/mdsal/binding/javav2/model/api/GeneratedType.java
+++ b/binding2/mdsal-binding2-generator-api/src/main/java/org/opendaylight/mdsal/binding/javav2/model/api/GeneratedType.java
@@ -10,6 +10,7 @@ package org.opendaylight.mdsal.binding.javav2.model.api;
 
 import com.google.common.annotations.Beta;
 import java.util.List;
+import java.util.Optional;
 
 /**
  * Every Java interface has to be specified with:
@@ -52,7 +53,7 @@ public interface GeneratedType extends Type, DocumentedType {
      *
      * @return comment string associated with Generated Type.
      */
-    String getComment();
+    TypeComment getComment();
 
     /**
      * Returns List of annotation definitions associated with generated type.
@@ -120,4 +121,11 @@ public interface GeneratedType extends Type, DocumentedType {
      * Returns parent type for data schema node builder
      */
     Type getParentTypeForBuilder();
+
+    /**
+     * Returns the YANG definition of this type, if available.
+     *
+     * @return YANG source definition, or empty when unavailable.
+     */
+    Optional<YangSourceDefinition> getYangSourceDefinition();
 }