From b138c559c8f09921b693ad446f83dd2ffcf2f52f Mon Sep 17 00:00:00 2001 From: Oleg Sukhodolsky Date: Sun, 28 Mar 2004 06:32:16 +0000 Subject: [PATCH] Scoping for javadoc checks (documentation) --- docs/config_javadoc.html | 171 +++++++++++++++++++++++++++------------ docs/releasenotes.html | 4 + 2 files changed, 123 insertions(+), 52 deletions(-) diff --git a/docs/config_javadoc.html b/docs/config_javadoc.html index 65893a936..c9bc44075 100644 --- a/docs/config_javadoc.html +++ b/docs/config_javadoc.html @@ -104,6 +104,12 @@ scope private + + excludeScope + visibility scope where Javadoc comments are not checked + scope + null + authorFormat pattern for @author tag @@ -164,6 +170,16 @@ <property name="versionFormat" value="\$Revision.*\$"/> </module> +

+ To configure the check for private classes only: +

+ 
+<module name="JavadocType">
+   <property name="scope" value="private"/>
+   <property name="excludescope" value="package"/>
+</module>
+

Package

@@ -230,6 +246,12 @@ scope private + + excludeScope + visibility scope where Javadoc comments are not checked + scope + null + allowUndeclaredRTE whether to allow documented exceptions that @@ -242,14 +264,14 @@ allowThrowsTagsForSubclasses whether to allow documented exceptions that are subclass of one of declared exception. - boolean + boolean false allowMissingParamTags whether to ignore errors when a method has parameters but does not have matching param tags in the javadoc. - boolean + boolean false @@ -257,14 +279,14 @@ whether to ignore errors when a method declares that it throws exceptions but does have matching throws tags in the javadoc. - boolean + boolean false allowMissingReturnTag whether to ignore errors when a method returns non-void type does have a return tag in the javadoc. - boolean + boolean false @@ -299,6 +321,17 @@ <module name="JavadocMethod"> <property name="scope" value="public"/> <property name="allowUndeclaredRTE" value="true"/> +</module> + +

+ To configure the check for methods which are in private , but not in protected scope: +

+ 
+<module name="JavadocMethod">
+   <property name="scope" value="private"/>
+   <property name="excludeScope" value="protected"/>
 </module>

Notes

@@ -363,6 +396,12 @@ convention of using a scope private + + excludeScope + visibility scope where Javadoc comments are not checked + scope + null +

Examples

@@ -378,6 +417,17 @@ convention of using a 
 <module name="JavadocVariable">
    <property name="scope" value="public"/>
+</module>
+
+

+ To configure the check for members which are in private, but not in protected scope: +

+ 
+<module name="JavadocVariable">
+   <property name="scope" value="private"/>
+   <property name="excludeScope" value="protected"/>
 </module>

Package

@@ -436,76 +486,93 @@ convention of using a scope visibility scope where Javadoc comments are checked scope - private - - - checkFirstSentence - Whether to check the first sentence for proper end of sentence. - boolean - true - - - checkEmptyJavadoc - Whether to check if the Javadoc is missing a describing text. - boolean - false - - - checkHtml - Whether to check for incomplete html tags. - boolean - true - - - tokens - definitions to check - - subset of tokens - INTERFACE_DEF, - CLASS_DEF, - METHOD_DEF, - CTOR_DEF, - VARIABLE_DEF - - - INTERFACE_DEF, - CLASS_DEF, - METHOD_DEF, - CTOR_DEF, - VARIABLE_DEF - - - - + private + + + excludeScope + visibility scope where Javadoc comments are not checked + scope + null + + + checkFirstSentence + Whether to check the first sentence for proper end of sentence. + boolean + true + + + checkEmptyJavadoc + Whether to check if the Javadoc is missing a describing text. + boolean + false + + + checkHtml + Whether to check for incomplete html tags. + boolean + true + + + tokens + definitions to check + + subset of tokens + INTERFACE_DEF, + CLASS_DEF, + METHOD_DEF, + CTOR_DEF, + VARIABLE_DEF + + + INTERFACE_DEF, + CLASS_DEF, + METHOD_DEF, + CTOR_DEF, + VARIABLE_DEF + + + +

Examples

To configure the default check: -

+ 

 <module name="JavadocStyle"/>
-
+

To configure the check for public scope: -

+ 

 <module name="JavadocStyle">
    <property name="scope" value="public"/>
 </module>
-
+ +

+ To configure the check for javadoc which is in private, but not in package scope: +

+ 
+<module name="JavadocStyle">
+   <property name="scope" value="private"/>
+   <property name="excludeScope" value="package"/>
+</module>
+

To configure the check to turn off first sentence checking: -

- 
+    

+    
 <module name="JavadocStyle">
    <property name="checkFirstSentence" value="false"/>
 </module>
-        

+

diff --git a/docs/releasenotes.html b/docs/releasenotes.html index 3ca80df4a..aa5f8c350 100644 --- a/docs/releasenotes.html +++ b/docs/releasenotes.html @@ -154,6 +154,10 @@

  • Added ignoreNonLocal property to UnusedParameter check to check only private and static methods (request 787683)
    • +
  • Added excludeScope property to + Javadoc(Method|Bariable|Type|Style) checks (request + 846108)
    • +