#478 javadoc variable check should allow exclusion of enums

Future
open
nobody
Check (274)
5
2012-10-10
2008-03-05
No

The javadoc variable check should have a boolean parameter (like "considerEnums"). If set, enums are evaluated, else the check is restricted to pure variable definitions.

Discussion

  • Oliver Burn

    Oliver Burn - 2008-03-05

    Logged In: YES
    user_id=218824
    Originator: NO

    So it is clear in my mind what you are asking, can you give some sample code and explain the desired behaviour. Thanks.

     
  • Florian Quadt

    Florian Quadt - 2008-03-05

    Logged In: YES
    user_id=1771704
    Originator: YES

    Example:

    public enum {
    SMALL,
    MEDIUM,
    HUGE
    }

    a) with 'considerEnums' set SMALL, MEDIUM and HUGE are marked by checkstyle to be commented with javadoc (check behaviour at the moment)
    b) with 'considerEnums' unset the code has no violations

     
  • Nathan Erwin

    Nathan Erwin - 2012-08-17

    I just uploaded a potential patch for this in checkstyle-Patches-3559103.

     

Log in to post a comment.

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks