[SPARK-9864] Replace `@since` JavaDoc tag by `@Since` annotation in MLlib

• Type: Documentation
• Status: Resolved
• Priority: Critical
• Resolution: Fixed
• Affects Version/s: 1.5.0
• Fix Version/s: 1.5.0
• Component/s: Documentation, ML, MLlib
• Target Version/s: 1.5.0
• Assignee: Manoj Kumar
• Reporter: Xiangrui Meng
• Shepherd: Xiangrui Meng
• Created: 12/Aug/15 05:18
• Updated: 21/Aug/15 21:19
• Resolved: 21/Aug/15 21:19

Description

After SPARK-8967, we should use @Since annotation instead of @since tag in JavaDoc. This helps reuse API doc for inherited methods and public variables in the constructor, e.g.:

@Since("1.0.0")
override def predict(...)

/**
 * ...
 */
@Since("1.2.0")
class KMeansModel(
    @Since("1.3.0") override val uid: String,
    @Since("1.4.0") val centers: Array[Vector])

Issue Links

• depends upon: SPARK-8967 Implement @since as an annotation
• links to: [Github] Pull Request #8352 (MechCoder)