The documentation for Javadoc checks should make clear
that scopes are treated inclusively; that is, scope
'private' also implies 'protected' and 'public'.
The current wording could be interpreted as meaning
that each scope is treated atomically.
The description of the scope and excludeScope
properties should be changed to start with "the most
Documentation for Scope (in property_types.html) should
explain that scopes have ordering.
Both JavadocMethod and JavadocVariable documentation
have the sentence, "To configure the check for
methods/members which are in private , but not in
protected scope", which should be changed to "To
configure the check to apply only to methods/members in
private or package scope". The JavadocStyle sentence,
"To configure the check for javadoc which is in
private, but not in package scope" should be changed to
"To configure the check to apply only to Javadoc for
private scope elements".
Instead of "To configure the default check", it would
be better to be more explicit: "To configure the
default check, which checks all scopes".
Log in to post a comment.