CODEWITHSUNDEEP
javaeclipsewarningsjavadoc
Kiril Kirilov
Kiril Kirilov

Reputation: 11257

Eclipse - how to set javadoc warnings only to specific folders, not the whole project

Some of my colleagues lack discipline and not always write documentation of their classes(not always = never). I was trying to force them to write documentation by setting project warnings for missing comment javadocs. We got two source folders 'src' and 'tests' - obviously not all @Test methods needs documentation and this warning there is redundant. But now all undocumented tests got these annoying warnings, the project got hundreds of warnings and I'm afraid that some real dangerous warnings will be missed(because there are hundreds of useless ones).

How to set warnings only on the 'src' folder, and ignore the warnings on 'tests' folder?

Upvotes: 6

Views: 1956

Answers (1)

Wojciech Owczarczyk
Wojciech Owczarczyk

Reputation: 5745

I'm afraid there is no setting to disable missing javadoc validation strictly for Test classes/methods. There even was a suggestion posted on Eclipse bugzilla here but eventually it came to an dead end.

The only, nonelegant way of solving this issue is by annotating those test methods with @SuppressWarnings("javadoc") annotation.

Upvotes: 5

Related Questions