[
https://issues.apache.org/jira/browse/SPARK-8967?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14692318#comment-14692318
]
Xiangrui Meng commented on SPARK-8967:
--------------------------------------
One example is `deprecated` annotation in Scala:
https://github.com/scala/scala/blob/2.10.x/src/library/scala/deprecated.scala.
However, ScalaDoc may have special handling for this annotation.
> Implement @since as an annotation
> ---------------------------------
>
> Key: SPARK-8967
> URL: https://issues.apache.org/jira/browse/SPARK-8967
> Project: Spark
> Issue Type: New Feature
> Components: Documentation, Spark Core
> Reporter: Xiangrui Meng
> Assignee: Xiangrui Meng
> Original Estimate: 1h
> Remaining Estimate: 1h
>
> We use @since tag in JavaDoc. There exists one issue. For a overloaded
> method, it inherits the doc from its parent if no JavaDoc is provided.
> However, if we want to add @since, we have to add JavaDoc. Then we need to
> copy the JavaDoc from parent, which makes it hard to keep docs in sync.
> A better solution would be implementing @since as an annotation, which is not
> part of the JavaDoc.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org
