mbeckerle commented on a change in pull request #113: Clean up scaladoc
URL: https://github.com/apache/incubator-daffodil/pull/113#discussion_r211404537
##########
File path: daffodil-sapi/src/main/scala/org/apache/daffodil/sapi/Daffodil.scala
##########
@@ -138,11 +138,11 @@ class Compiler private[sapi] () {
* Reload a saved parser from a file
*
* To allow jar-file packaging, (where the savedParser might be part of a
jar),
- * it is recommended to use the other version of
[[Compiler#reload(savedParser:java\.nio\.channels\.ReadableByteChannel)*]]
where the argument is
+ * it is recommended to use the other version of
[[Compiler.reload(savedParser:java\.nio\.channels\.ReadableByteChannel)*]]
where the argument is
Review comment:
Honestly, I think these links that actually include the parameter types are
pointless. What you want is a link to the right method, but there's no need for
the method args to be displayed in the link text. Especially if the types are
going to have their package names spelled out. It's just unreadable. It's much
better to say "the other version of Compiler.reload" in prose than to have the
method signature redundantly expressed here.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
