[GitHub] zachgk commented on issue #13189: [WIP] Fix scaladoc build errors

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

zachgk commented on issue #13189: [WIP] Fix scaladoc build errors
URL: https://github.com/apache/incubator-mxnet/pull/13189#issuecomment-437544147
 
 
   The current scaladoc build command and output are as follows (note that this is after https://github.com/apache/incubator-mxnet/pull/13210 as well):
   ```
   ubuntu@ip-172-31-68-239:~/incubator-mxnet/scala-package$ scaladoc `find . -type f -name "*.scala" | egrep "\.\/core|\.\/infer" | egrep -v "Suite"` -classpath `find native -name "*.jar" | grep "target/lib/" | tr '\n' ':'`:`find macros -name "*-SNAPSHOT.jar"` -feature -deprecation
   model contains 139 documentable templates
   ./core/src/main/scala/org/apache/mxnet/module/BaseModule.scala:368: warning: Could not find any member to link for "IOException".
     /**
     ^
   one warning found
   ```
   
   I have enabled the feature and deprecation flags which show additional warnings (which have also been fixed).  The fixed errors and warnings were:
   - Missing dependencies fixed by adding target/lib to the scaladoc generation classpath
   - Treat macro module as dependency for docs by adding it to classpath as well
   - Remove "@throws" no longer in use
   - Scaladoc interprets contents surrounded by [[ as a link and throws a warning if it can't be resolved.  It is used for NDArrays so I convert them to [ [ instead
   - Various scala features such as implicit methods require a corresponding import from the scala.language package
   - The "@deprecated" flag takes two parameters: a message and the version/date of deprecation (https://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html)
   
   Comments about the remaining IOException warning are in the source issue https://github.com/apache/incubator-mxnet/issues/13161.

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services