Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Fix descriptions in scaladocs for macro ndarray/sybmol APIs #13210

Merged
merged 1 commit into from
Nov 17, 2018
Merged

Fix descriptions in scaladocs for macro ndarray/sybmol APIs #13210

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions scala-package/macros/src/main/scala/org/apache/mxnet/APIDocGenerator.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,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}"
Expand Down