maxvetrenko / checkstyle

Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. By default it supports the Sun Code Conventions, but is highly configurable. It can be invoked with an ANT task and a command line program.
http://checkstyle.sourceforge.net/
GNU Lesser General Public License v2.1
0 stars 0 forks source link

Update JavadocMethodCheck #35

Closed maxvetrenko closed 10 years ago

maxvetrenko commented 10 years ago

http://checkstyle.sourceforge.net/config_javadoc.html#JavadocMethod Update existing Check to allow Override methods without Javadoc. Need to add allowNoJavaDocOnOverridenMethods option

romani commented 10 years ago

instead of hard-coding Override, It might be more useful to update a Check to let user provide names(RegExp or String[]) for annotations that allow missed javadoc.

Example : @Test, @Override, @VisibleForTesting , .....

maxvetrenko commented 10 years ago

@romani, Understood

romani commented 10 years ago

so provide me a example how configuration will looks like

maxvetrenko commented 10 years ago

@romani

<module name="JavadocMethodCheck">>
<property name="ignoreAnnotations" value="Test, Override"/>
</module>

romani commented 10 years ago

What is a reason to force user have "@" in front of each element in list?

maxvetrenko commented 10 years ago

@romani, I agree with you, there is no any reason to force "@". Removed.

romani commented 10 years ago

where is not tags in Java. It is annotation.

maxvetrenko commented 10 years ago

@romani, corrected config.

romani commented 10 years ago

annotationsWithoutJavadoc

do you check JavaDoc for annotations ?

please name option as "ignoreAnnotations".

similar naming could be found at http://checkstyle.sourceforge.net/config_sizes.html#LineLength, http://checkstyle.sourceforge.net/config_misc.html#Regexp

maxvetrenko commented 10 years ago

@romani renamed.