#332 Exclude getter and setters from JavaDoc checking.

release_4.0
closed
Oliver Burn
None
5
2012-10-10
2004-11-08
R. Koster
No

For most getter and setter methods it is not useful to
add JavaDoc. So to prevent warnings on those methods it
would be nice to be able to exclude a set of methods
from JavaDoc checking. For example: exclude all methods
starting with 'get' and 'set'. For example by using an
exclude pattern like: exclude='get, set'.

Discussion

  • Patrick Fust
    Patrick Fust
    2005-02-09

    Logged In: YES
    user_id=311735

    I think it would be better if it simply excluded get-methods
    that are one-liners and are returning only fields.
    Same with setters.

     
  • Oliver Burn
    Oliver Burn
    2005-02-09

    Logged In: YES
    user_id=218824

    I agree - I propose to add support for this in the
    JavadocMethod check. This support will be off by default to
    maintain current behavior.

     
  • Logged In: YES
    user_id=571847

    How difficult would it be to add this kind of support also
    to the checks that count the number of methods?
    Would it be possible to have a common method that checks the
    "simplicity" of a method?

     
  • Oliver Burn
    Oliver Burn
    2005-03-21

    Logged In: YES
    user_id=218824

    I have added support. It is available in CVS for the next
    4.0 release.