You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@spark.apache.org by "Xiangrui Meng (JIRA)" <ji...@apache.org> on 2015/08/21 18:49:47 UTC
[jira] [Updated] (SPARK-9864) Replace `@since` JavaDoc tag by
`@Since` annotation in MLlib
[ https://issues.apache.org/jira/browse/SPARK-9864?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Xiangrui Meng updated SPARK-9864:
---------------------------------
Summary: Replace `@since` JavaDoc tag by `@Since` annotation in MLlib (was: Replace `@since` JavaDoc tag by `@Since` annotation)
> 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
>
> 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