[incubator-mxnet] branch master updated: Java doc (#13368)

[la...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

lanking pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-mxnet.git


The following commit(s) were added to refs/heads/master by this push:
     new 5c73fc3  Java doc (#13368)
5c73fc3 is described below

commit 5c73fc373cad52e1488a41c9f065f89abd2d860a
Author: Zach Kimberg <za...@kimberg.com>
AuthorDate: Tue Nov 27 13:10:23 2018 -0800

    Java doc (#13368)
    
    * Fix scaladoc and javadoc errors
    
    * Stop on errors starting on scala 1.3.x build
---
 docs/mxdoc.py                                      | 24 +++++++++++++++-------
 .../scala/org/apache/mxnet/javaapi/NDArray.scala   |  1 +
 .../mxnet/infer/javaapi/ObjectDetector.scala       |  1 +
 3 files changed, 19 insertions(+), 7 deletions(-)

diff --git a/docs/mxdoc.py b/docs/mxdoc.py
index 136d761..7be4b90 100644
--- a/docs/mxdoc.py
+++ b/docs/mxdoc.py
@@ -110,13 +110,17 @@ def build_scala(app):
 def build_scala_docs(app):
     """build scala doc and then move the outdir"""
     scala_path = app.builder.srcdir + '/../scala-package'
-    scala_doc_sources = 'find . -type f -name "*.scala" | egrep \"\.\/core|\.\/infer\" | egrep -v \"Suite\"'
+    scala_doc_sources = 'find . -type f -name "*.scala" | egrep \"\.\/core|\.\/infer\" | egrep -v \"\/javaapi\"  | egrep -v \"Suite\"'
     scala_doc_classpath = ':'.join([
         '`find native -name "*.jar" | grep "target/lib/" | tr "\\n" ":" `',
-        '`find macros -name "*-SNAPSHOT.jar" | tr "\\n" ":" `'
+        '`find macros -name "*-SNAPSHOT.jar" | tr "\\n" ":" `',
+        '`find core -name "*-SNAPSHOT.jar" | tr "\\n" ":" `',
+        '`find infer -name "*-SNAPSHOT.jar" | tr "\\n" ":" `'
     ])
-    _run_cmd('cd {}; scaladoc `{}` -classpath {} -feature -deprecation; exit 0'
-             .format(scala_path, scala_doc_sources, scala_doc_classpath))
+    # There are unresolvable errors on mxnet 1.2.x. We are ignoring those errors while aborting the ci on newer versions
+    scala_ignore_errors = '; exit 0' if '1.2.' in _BUILD_VER else ''
+    _run_cmd('cd {}; scaladoc `{}` -classpath {} -feature -deprecation {}'
+             .format(scala_path, scala_doc_sources, scala_doc_classpath, scala_ignore_errors))
     dest_path = app.builder.outdir + '/api/scala/docs'
     _run_cmd('rm -rf ' + dest_path)
     _run_cmd('mkdir -p ' + dest_path)
@@ -128,9 +132,15 @@ def build_scala_docs(app):
 def build_java_docs(app):
     """build java docs and then move the outdir"""
     java_path = app.builder.srcdir + '/../scala-package'
-    # scaldoc fails on some apis, so exit 0 to pass the check
-    find_cmd = '`find . -type f -name "*.scala" | egrep \"\.\/core|\.\/infer\" | egrep \"\/javaapi\" | egrep -v \"Suite\"`'
-    _run_cmd('cd ' + java_path + '; scaladoc ' + find_cmd +'; exit 0')
+    java_doc_sources = 'find . -type f -name "*.scala" | egrep \"\.\/core|\.\/infer\" | egrep \"\/javaapi\" | egrep -v \"Suite\"'
+    java_doc_classpath = ':'.join([
+        '`find native -name "*.jar" | grep "target/lib/" | tr "\\n" ":" `',
+        '`find macros -name "*-SNAPSHOT.jar" | tr "\\n" ":" `',
+        '`find core -name "*-SNAPSHOT.jar" | tr "\\n" ":" `',
+        '`find infer -name "*-SNAPSHOT.jar" | tr "\\n" ":" `'
+    ])
+    _run_cmd('cd {}; scaladoc `{}` -classpath {} -feature -deprecation'
+             .format(java_path, java_doc_sources, java_doc_classpath))
     dest_path = app.builder.outdir + '/api/java/docs'
     _run_cmd('rm -rf ' + dest_path)
     _run_cmd('mkdir -p ' + dest_path)
diff --git a/scala-package/core/src/main/scala/org/apache/mxnet/javaapi/NDArray.scala b/scala-package/core/src/main/scala/org/apache/mxnet/javaapi/NDArray.scala
index 6b4f4bd..198102d 100644
--- a/scala-package/core/src/main/scala/org/apache/mxnet/javaapi/NDArray.scala
+++ b/scala-package/core/src/main/scala/org/apache/mxnet/javaapi/NDArray.scala
@@ -20,6 +20,7 @@ package org.apache.mxnet.javaapi
 import org.apache.mxnet.javaapi.DType.DType
 
 import collection.JavaConverters._
+import scala.language.implicitConversions
 
 @AddJNDArrayAPIs(false)
 object NDArray extends NDArrayBase {
diff --git a/scala-package/infer/src/main/scala/org/apache/mxnet/infer/javaapi/ObjectDetector.scala b/scala-package/infer/src/main/scala/org/apache/mxnet/infer/javaapi/ObjectDetector.scala
index 08fffb4..3014f8d 100644
--- a/scala-package/infer/src/main/scala/org/apache/mxnet/infer/javaapi/ObjectDetector.scala
+++ b/scala-package/infer/src/main/scala/org/apache/mxnet/infer/javaapi/ObjectDetector.scala
@@ -25,6 +25,7 @@ import org.apache.mxnet.javaapi.{Context, DataDesc, NDArray, Shape}
 
 import scala.collection.JavaConverters
 import scala.collection.JavaConverters._
+import scala.language.implicitConversions
 
 /**
   * The ObjectDetector class helps to run ObjectDetection tasks where the goal