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

["Xiangrui Meng (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/SPARK-9864?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Xiangrui Meng resolved SPARK-9864.
----------------------------------
       Resolution: Fixed
    Fix Version/s: 1.5.0

Issue resolved by pull request 8352
[https://github.com/apache/spark/pull/8352]

> Replace `@since` JavaDoc tag by `@Since` annotation in MLlib
> ------------------------------------------------------------
>
>                 Key: SPARK-9864
>                 URL: https://issues.apache.org/jira/browse/SPARK-9864
>             Project: Spark
>          Issue Type: Documentation
>          Components: Documentation, ML, MLlib
>    Affects Versions: 1.5.0
>            Reporter: Xiangrui Meng
>            Assignee: Manoj Kumar
>            Priority: Critical
>             Fix For: 1.5.0
>
>
> 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.:
> {code}
> @Since("1.0.0")
> override def predict(...)
> {code}
> {code}
> /**
>  * ...
>  */
> @Since("1.2.0")
> class KMeansModel(
>     @Since("1.3.0") override val uid: String,
>     @Since("1.4.0") val centers: Array[Vector])
> {code}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org