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/12 23:29:45 UTC

[jira] [Resolved] (SPARK-8967) Implement @since as an annotation

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

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

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

> 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
>             Fix For: 1.5.0
>
>   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-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org