[SPARK-8967] Implement @since as an annotation

• Type: New Feature
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.5.0
• Component/s: Documentation, Spark Core
• Target Version/s: 1.5.0
• Assignee: Xiangrui Meng
• Reporter: Xiangrui Meng
• Created: 10/Jul/15 00:35
• Updated: 12/Aug/15 21:28
• Resolved: 12/Aug/15 21:28

Description

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.

Issue Links

• is depended upon by: SPARK-9864 Replace `@since` JavaDoc tag by `@Since` annotation in MLlib
• relates to: SPARK-7751 Add @Since annotation to stable and experimental methods in MLlib
• links to: [Github] Pull Request #8131 (mengxr)