Update of /cvsroot/bprocessor/tools/checkstyle
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv20868/checkstyle
Modified Files:
checkstyle.xml
Log Message:
Relaxes the style policy on javadoc comments Ð they are now only enforced on public types, fields and methods.
Note: use /** {@inheritDoc} */ on overriding methods.
Index: checkstyle.xml
===================================================================
RCS file: /cvsroot/bprocessor/tools/checkstyle/checkstyle.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** checkstyle.xml 9 Aug 2006 13:46:14 -0000 1.4
--- checkstyle.xml 7 Dec 2006 13:48:03 -0000 1.5
***************
*** 56,66 ****
<!-- JavaDoc guidelines -->
<module name="JavadocMethod">
! <property name="scope" value="private"/>
</module>
<module name="JavadocVariable">
! <property name="scope" value="private"/>
</module>
<module name="JavadocType">
! <property name="scope" value="private"/>
</module>
--- 56,66 ----
<!-- JavaDoc guidelines -->
<module name="JavadocMethod">
! <property name="scope" value="public"/>
</module>
<module name="JavadocVariable">
! <property name="scope" value="public"/>
</module>
<module name="JavadocType">
! <property name="scope" value="public"/>
</module>
|