Add generation of javadoc for Builder.withKey()

Fix warnings about missing javadoc for method withKey() in Builder
classes generated by BuilderTemplate.xtend.

JIRA: MDSAL-758
Change-Id: Ia871623b608a9dcdfb4fec284622843a7365e839
Signed-off-by: Samuel Schneider <samuel.schneider@pantheon.tech>
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/BuilderTemplate.xtend b/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/BuilderTemplate.xtend
index 1427d2edbc73a4412bc7d6cf6fab58606b3f825c..de1743b90dd19ebe192e95673756368e740ffb10 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
@@ -12,6 +12,7 @@ import static org.opendaylight.mdsal.binding.model.ri.BindingTypes.DATA_OBJECT
 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.AUGMENTABLE_AUGMENTATION_NAME
 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.AUGMENTATION_FIELD
 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.BINDING_CONTRACT_IMPLEMENTED_INTERFACE_NAME
+import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.IDENTIFIABLE_KEY_NAME
 
 import com.google.common.collect.ImmutableList
 import com.google.common.collect.ImmutableSet
@@ -441,6 +442,13 @@ class BuilderTemplate extends AbstractBuilderTemplate {
      */
     def private generateSetters() '''
         «IF keyType !== null»
+            /**
+             * Set the key value corresponding to {@link «targetType.importedName»#«IDENTIFIABLE_KEY_NAME»()} to the specified
+             * value.
+             *
+             * @param key desired value
+             * @return this builder
+             */
             public «type.getName» withKey(final «keyType.importedName» key) {
                 this.key = key;
                 return this;