Generate javadoc for builder setters

Setters are utterly undocumented. Add javadocs which point to the
corresponding interface method.

JIRA: MDSAL-755
Change-Id: I1d51ea8499d430ed231197e6448a1122d7ac0f27
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
(cherry picked from commit 4de1992fd1e85b2216987cdc47fbaf52088b2d9f)

diff --git a/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/BuilderTemplate.xtend b/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/BuilderTemplate.xtend
index 6e9eba483ff0f7d10148a9913bf330be8d4d4c61..c29f8aea4b59143f86d0be305e52a3f712545974 100644 (file)
--- a/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/BuilderTemplate.xtend
+++ b/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/BuilderTemplate.xtend
@@ -359,7 +359,7 @@ class BuilderTemplate extends AbstractBuilderTemplate {
         «ENDFOR»
     '''
 
-    def private generateSetter(GeneratedProperty field) {
+    def private generateSetter(BuilderGeneratedProperty field) {
         val returnType = field.returnType
         if (returnType instanceof ParameterizedType) {
             if (Types.isListType(returnType) || Types.isSetType(returnType)) {
@@ -375,11 +375,19 @@ class BuilderTemplate extends AbstractBuilderTemplate {
         return generateSimpleSetter(field, returnType)
     }
 
-    def private generateListSetter(GeneratedProperty field, Type actualType) '''
+    def private generateListSetter(BuilderGeneratedProperty field, Type actualType) '''
         «val restrictions = restrictionsForSetter(actualType)»
         «IF restrictions !== null»
             «generateCheckers(field, restrictions, actualType)»
         «ENDIF»
+
+        /**
+         * Set the property corresponding to {@link «targetType.importedName»#«field.getterName»()} to the specified
+         * value.
+         *
+         * @param values desired value
+         * @return this builder
+         */
         public «type.getName» set«field.getName.toFirstUpper»(final «field.returnType.importedName» values) {
         «IF restrictions !== null»
             if (values != null) {
@@ -394,11 +402,19 @@ class BuilderTemplate extends AbstractBuilderTemplate {
 
     '''
 
-    def private generateMapSetter(GeneratedProperty field, Type actualType) '''
+    def private generateMapSetter(BuilderGeneratedProperty field, Type actualType) '''
         «val restrictions = restrictionsForSetter(actualType)»
         «IF restrictions !== null»
             «generateCheckers(field, restrictions, actualType)»
         «ENDIF»
+
+        /**
+         * Set the property corresponding to {@link «targetType.importedName»#«field.getterName»()} to the specified
+         * value.
+         *
+         * @param values desired value
+         * @return this builder
+         */
         public «type.getName» set«field.name.toFirstUpper»(final «field.returnType.importedName» values) {
         «IF restrictions !== null»
             if (values != null) {
@@ -412,13 +428,20 @@ class BuilderTemplate extends AbstractBuilderTemplate {
         }
     '''
 
-    def private generateSimpleSetter(GeneratedProperty field, Type actualType) '''
+    def private generateSimpleSetter(BuilderGeneratedProperty field, Type actualType) '''
         «val restrictions = restrictionsForSetter(actualType)»
         «IF restrictions !== null»
 
             «generateCheckers(field, restrictions, actualType)»
         «ENDIF»
 
+        /**
+         * Set the property corresponding to {@link «targetType.importedName»#«field.getterName»()} to the specified
+         * value.
+         *
+         * @param value desired value
+         * @return this builder
+         */
         «val setterName = "set" + field.getName.toFirstUpper»
         public «type.getName» «setterName»(final «field.returnType.importedName» value) {
             «IF restrictions !== null»