GitHub user mengxr opened a pull request:

    https://github.com/apache/spark/pull/8131

    [SPARK-8967] [DOC] add Since annotation

    Add `@Since` as a Scala annotation. The benefit is that we can use it 
without having explicit JavaDoc. This is useful for inherited methods. The 
limitation is that is doesn't show up in the generated Java API documentation. 
This might be fixed by modifying genjavadoc. I think we could leave it as a 
TODO.
    
    This is how the generated Scala doc looks:
    
    `@since` JavaDoc tag:
    
    ![screen shot 2015-08-11 at 10 00 37 
pm](https://cloud.githubusercontent.com/assets/829644/9230761/fa72865c-40d8-11e5-807e-0f3c815c5acd.png)
    
    `@Since` annotation:
    
    ![screen shot 2015-08-11 at 10 00 28 
pm](https://cloud.githubusercontent.com/assets/829644/9230764/0041d7f4-40d9-11e5-8124-c3f3e5d5b31f.png)
    
    @rxin 

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/mengxr/spark SPARK-8967

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/spark/pull/8131.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #8131
    
----
commit 8f4b54c60c10993d2bf4408e2ab72ea91bd65cff
Author: Xiangrui Meng <[email protected]>
Date:   2015-08-12T16:35:06Z

    add Since annotation

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to