spark-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Xiangrui Meng (JIRA)" <>
Subject [jira] [Commented] (SPARK-8967) Implement @since as an annotation
Date Tue, 11 Aug 2015 21:49:46 GMT


Xiangrui Meng commented on SPARK-8967:

One example is `deprecated` annotation in Scala:
However, ScalaDoc may have special handling for this annotation.

> Implement @since as an annotation
> ---------------------------------
>                 Key: SPARK-8967
>                 URL:
>             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

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message