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/07/10 02:36:05 UTC

[jira] [Created] (SPARK-8967) Add @since as an annotation

Xiangrui Meng created SPARK-8967:
------------------------------------

             Summary: Add @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


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