[incubator-mxnet] branch master updated: Fix descriptions in scaladocs for macro ndarray/sybmol APIs (#13210)

[in...@apache.org]

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

indhub 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 dfeb6b0  Fix descriptions in scaladocs for macro ndarray/sybmol APIs (#13210)
dfeb6b0 is described below

commit dfeb6b017445b4a6b37a67abc8d8e23e3b8f4a0a
Author: Zach Kimberg <za...@kimberg.com>
AuthorDate: Fri Nov 16 16:49:04 2018 -0800

    Fix descriptions in scaladocs for macro ndarray/sybmol APIs (#13210)
---
 .../src/main/scala/org/apache/mxnet/APIDocGenerator.scala | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/scala-package/macros/src/main/scala/org/apache/mxnet/APIDocGenerator.scala b/scala-package/macros/src/main/scala/org/apache/mxnet/APIDocGenerator.scala
index 7c1edb5..ce12dc7 100644
--- a/scala-package/macros/src/main/scala/org/apache/mxnet/APIDocGenerator.scala
+++ b/scala-package/macros/src/main/scala/org/apache/mxnet/APIDocGenerator.scala
@@ -114,11 +114,20 @@ private[mxnet] object APIDocGenerator extends GeneratorBase {
   }
 
   def generateAPIDocFromBackend(func: Func, withParam: Boolean = true): String = {
-    val desc = func.desc.split("\n")
-      .mkString("  * <pre>\n", "\n  * ", "  * </pre>\n")
+    def fixDesc(desc: String): String = {
+      var curDesc = desc
+      var prevDesc = ""
+      while ( curDesc != prevDesc ) {
+        prevDesc = curDesc
+        curDesc = curDesc.replace("[[", "`[ [").replace("]]", "] ]")
+      }
+      curDesc
+    }
+    val desc = fixDesc(func.desc).split("\n")
+      .mkString("  *\n  * {{{\n  *\n  * ", "\n  * ", "\n  * }}}\n  * ")
 
     val params = func.listOfArgs.map { absClassArg =>
-      s"  * @param ${absClassArg.safeArgName}\t\t${absClassArg.argDesc}"
+      s"  * @param ${absClassArg.safeArgName}\t\t${fixDesc(absClassArg.argDesc)}"
     }
 
     val returnType = s"  * @return ${func.returnType}"