Copy JavaDoc to @SharedPref class and @DefaultXXX methods #1551

Activity

1. WonderCsabo

   added

   Enhancement

   on Sep 15, 2015
2. WonderCsabo commented on Sep 15, 2015

   

   WonderCsabo

   on Sep 15, 2015

   MemberAuthor

   More actions

   I assign this issue to @dodgex .
3. dodgex commented on Sep 17, 2015

   

   dodgex

   on Sep 17, 2015

   Member

   More actions

   how to handle the user provided @return ?

   e.g.

       /**
        * The Age!
        *
        * @return the age as int
        */
       @DefaultInt(42)
       int age();

   generates:

       /**
        * The Age!
        * 
        *  @return the age as int
        */
       public IntPrefField age() {
           return intField("age", 42);
       }

   what is actually not correct.

   also i'd like to add something like * Defaults to: 42 but that should be above the @return and other tags
4. dodgex commented on Sep 17, 2015

   

   dodgex

   on Sep 17, 2015

   Member

   More actions

   i think we should just copy the javadoc and ignore the default value. or we have to add the default value to the top of the javadoc
5. dodgex commented on Sep 17, 2015

   

   dodgex

   on Sep 17, 2015

   Member

   More actions

   in my current implementation i add <p><b>Defaults to</b>: 42</p> before the given javadoc comment
6. WonderCsabo commented on Sep 17, 2015

   

   WonderCsabo

   on Sep 17, 2015

   MemberAuthor

   More actions

   I think:

     /**
        * The Age!
        * 
        *  @return The PrefField object for chaining calls to work with the preference
        */
       public IntPrefField age() {

   And for the editor methods:

   @return The PrefEditorField object for chaining calls to edit the preference

   Otherwise i think your proposal is OK, @dodgex .
7. dodgex commented on Sep 17, 2015

   

   dodgex

   on Sep 17, 2015

   Member

   More actions

   the problem is, that depending on compiler/ide configuration the javadoc on the interface has to be valid -> requires @return

   we would need to remove/replace the @return if we want to add that message on the age()
8. WonderCsabo commented on Sep 17, 2015

   

   WonderCsabo

   on Sep 17, 2015

   MemberAuthor

   More actions

   You are right. Then stick with your proposal.
9. WonderCsabo commented on Sep 17, 2015

   

   WonderCsabo

   on Sep 17, 2015

   MemberAuthor

   More actions

   I think we should copy the javadoc to the editor methods as well.
10. dodgex commented on Sep 17, 2015

    

    dodgex

    on Sep 17, 2015

    Member

    More actions

    oh. i did not realize that there are more methods. :/ i'll add them.
11. dodgex commented on Sep 17, 2015

    

    dodgex

    on Sep 17, 2015

    Member

    More actions

    i updated the PR btw :)
12. WonderCsabo commented on Sep 18, 2015

    

    WonderCsabo

    on Sep 18, 2015

    MemberAuthor

    More actions

    Implemented.
13. WonderCsabo

    closed this as completedon Sep 18, 2015