stevedlawrence commented on a change in pull request #456:
URL: https://github.com/apache/incubator-daffodil/pull/456#discussion_r522956416
##########
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:
I agree with removing redundancy, but I don't see much value in trying
to save lines or even removing descriptions. It maybe feels verbose, but this
is standard practice in Javadocs. And perhaps the real issue is this docs are
just not good docs. For example, maybe this should be more along the lines of:
```scala
/**
* Get the local name of the user defined function, excluding a namespace or
prefix
*
* @returns the local name
*/
```
Which I think does provide some added value that just "name()" doesn't
necessarily imply
----------------------------------------------------------------
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:
[email protected]
