From: Robert Varga <robert.varga@pantheon.tech>
Date: Wed, 27 Apr 2022 16:36:39 +0000 (+0200)
Subject: Generate documentation for builder getters
X-Git-Tag: v10.0.0~72
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=commitdiff_plain;h=0a6a2b40e92438ca06e73dfd5ffedb733267a9aa

Generate documentation for builder getters

Javadoc rightfully complains about Builders not documenting its getFoo()
methods. Add the javadocs pointing to their interface counterparts.

JIRA: MDSAL-755
Change-Id: Iacb5480b3bc0490d7c088add9e681076d067635d
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
---

diff --git a/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/AbstractBuilderTemplate.xtend b/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/AbstractBuilderTemplate.xtend
index c558ada0f5..464102efba 100644
--- a/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/AbstractBuilderTemplate.xtend
+++ b/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/AbstractBuilderTemplate.xtend
@@ -83,7 +83,15 @@ abstract class AbstractBuilderTemplate extends BaseTemplate {
      */
     def final generateGetters(boolean addOverride) '''
         «IF keyType !== null»
-            «IF addOverride»@«OVERRIDE.importedName»«ENDIF»
+            «IF addOverride»
+            @«OVERRIDE.importedName»
+            «ELSE»
+            /**
+             * Return current value associated with the property corresponding to {@link «targetType.importedName»#«BindingMapping.IDENTIFIABLE_KEY_NAME»()}.
+             *
+             * @return current value
+             */
+            «ENDIF»
             public «keyType.importedName» «BindingMapping.IDENTIFIABLE_KEY_NAME»() {
                 return key;
             }
@@ -91,7 +99,15 @@ abstract class AbstractBuilderTemplate extends BaseTemplate {
         «ENDIF»
         «IF !properties.empty»
             «FOR field : properties SEPARATOR '\n'»
-                «IF addOverride»@«OVERRIDE.importedName»«ENDIF»
+                «IF addOverride»
+                @«OVERRIDE.importedName»
+                «ELSE»
+                /**
+                 * Return current value associated with the property corresponding to {@link «targetType.importedName»#«field.getterName»()}.
+                 *
+                 * @return current value
+                 */
+                «ENDIF»
                 «field.getterMethod»
             «ENDFOR»
         «ENDIF»