stevedlawrence commented on a change in pull request #113: Clean up scaladoc
URL: https://github.com/apache/incubator-daffodil/pull/113#discussion_r211592581
##########
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:
Agreed. In order to have a link, scala requires parameters if there is
ambiguity due to method overloading. However, one can provide an alternative
text so that the parameters aren't shown. I'll go through all the scala links
to make sure we're not showing excessive information. Javadoc seems to do a
better job and making readable docs without much effort.
----------------------------------------------------------------
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
