You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@directory.apache.org by Stefan Seelmann <se...@apache.org> on 2010/09/26 22:44:10 UTC

Re: svn commit: r1001509 - /directory/buildtools/trunk/checkstyle/src/main/resources/directory-checks.xml

Hi,

I disabled Javadoc checks for private methods. I don't think it makes
sense to document private methods at all. The downside of the disabled
check is that we also don't find existing wrong Javadocs (changed
parameters, etc.). If there are any objections we can activate the
check again.

Kind Regards,
Stefan

On Sun, Sep 26, 2010 at 10:39 PM,  <se...@apache.org> wrote:
> Author: seelmann
> Date: Sun Sep 26 20:39:46 2010
> New Revision: 1001509
>
> URL: http://svn.apache.org/viewvc?rev=1001509&view=rev
> Log:
> No Javadoc checks for private methods
>
> Modified:
>    directory/buildtools/trunk/checkstyle/src/main/resources/directory-checks.xml
>
> Modified: directory/buildtools/trunk/checkstyle/src/main/resources/directory-checks.xml
> URL: http://svn.apache.org/viewvc/directory/buildtools/trunk/checkstyle/src/main/resources/directory-checks.xml?rev=1001509&r1=1001508&r2=1001509&view=diff
> ==============================================================================
> --- directory/buildtools/trunk/checkstyle/src/main/resources/directory-checks.xml (original)
> +++ directory/buildtools/trunk/checkstyle/src/main/resources/directory-checks.xml Sun Sep 26 20:39:46 2010
> @@ -84,7 +84,9 @@
>
>         <!-- Checks for Javadoc comments.                     -->
>         <!-- See http://checkstyle.sf.net/config_javadoc.html -->
> -        <module name="JavadocMethod"/>
> +        <module name="JavadocMethod">
> +          <property name="scope" value="protected"/>
> +        </module>
>         <module name="JavadocType">
>           <property name="scope" value="public"/>
>         </module>
>
>
>

Re: svn commit: r1001509 - /directory/buildtools/trunk/checkstyle/src/main/resources/directory-checks.xml

Posted by Emmanuel Lecharny <el...@gmail.com>.
  On 9/26/10 10:44 PM, Stefan Seelmann wrote:
> Hi,
>
> I disabled Javadoc checks for private methods. I don't think it makes
> sense to document private methods at all. The downside of the disabled
> check is that we also don't find existing wrong Javadocs (changed
> parameters, etc.). If there are any objections we can activate the
> check again.

Makes sense to me.


-- 
Regards,
Cordialement,
Emmanuel Lécharny
www.iktek.com