[SPARK-3249] Fix links in ScalaDoc that cause warning messages in `sbt/sbt unidoc`

• Type: Sub-task
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.1.0
• Fix Version/s: 2.2.0
• Component/s: Documentation, MLlib
• Assignee: Hyukjin Kwon
• Reporter: Xiangrui Meng
• Created: 27/Aug/14 08:27
• Updated: 12/Dec/22 18:11
• Resolved: 17/Jan/17 12:28

Description

If there are multiple overloaded versions of a method, we should make the links more specific. Otherwise, `sbt/sbt unidoc` generates warning messages like the following:

[warn] mllib/src/main/scala/org/apache/spark/mllib/tree/DecisionTree.scala:305: The link target "org.apache.spark.mllib.tree.DecisionTree$#trainClassifier" is ambiguous. Several members fit the target:
[warn] (input: org.apache.spark.api.java.JavaRDD[org.apache.spark.mllib.regression.LabeledPoint],numClassesForClassification: Int,categoricalFeaturesInfo: java.util.Map[Integer,Integer],impurity: String,maxDepth: Int,maxBins: Int): org.apache.spark.mllib.tree.model.DecisionTreeModel in object DecisionTree [chosen]
[warn] (input: org.apache.spark.rdd.RDD[org.apache.spark.mllib.regression.LabeledPoint],numClassesForClassification: Int,categoricalFeaturesInfo: Map[Int,Int],impurity: String,maxDepth: Int,maxBins: Int): org.apache.spark.mllib.tree.model.DecisionTreeModel in object DecisionTree

Issue Links

• duplicates: SPARK-12047 Unhelpful error messages generated by JavaDoc while doing sbt unidoc
• links to: [Github] Pull Request #16604 (HyukjinKwon)