[
https://issues.apache.org/jira/browse/SPARK-9864?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Xiangrui Meng updated SPARK-9864:
---------------------------------
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.:
{code}
@Since("1.0.0")
override def predict(...)
{code}
{code}
class KMeansModel(
@Since("1.3.0") override val uid: String,
@Since("1.4.0") val centers: Array[Vector])
{code}
was:After SPARK-8967, we should use @Since annotation instead of @since tag
in JavaDoc. This helps reuse API doc for inherited methods.
> Replace `@since` JavaDoc tag by `@Since` annotation
> ---------------------------------------------------
>
> 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}
> 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: [email protected]
For additional commands, e-mail: [email protected]
