[GitHub] [incubator-daffodil] mbeckerle commented on a change in pull request #456: Support all LTS and one non-LTS Java versions

[GitBox <gi...@apache.org>]

mbeckerle commented on a change in pull request #456:
URL: https://github.com/apache/incubator-daffodil/pull/456#discussion_r522389002



##########
File path: daffodil-udf/src/main/java/org/apache/daffodil/udf/UserDefinedFunctionIdentification.java
##########
@@ -28,11 +28,21 @@
  *
  * It must have the name and namespaceURI fields initialized with the namespace
  * and name callers would be expected to use in the schema.
- *
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 public @interface UserDefinedFunctionIdentification {
+  /**
+   * Get the name of the user defined function
+   *
+   * @return the name of the user defined function
+   */
   String name();
+
+  /**
+   * Get the namespace URI of the user defined function

Review comment:
       Gaaak. My job is at the redundancy department is where I work.  :-)
   
   I hate having to have 6 lines All of which basically say the same thing, and add no value over just the function signature itself.  To me this is just code pollution. Might as well say:
   ```
   /**
    * Read the f***ing method name.  (RTFM)
    */
   ```
   
   What happens if you have no javadoc for this at all? The javadoc generated will still show this as a public member right? 




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org