user1089097
user1089097

Reputation: 145

How to force compile-warnings if not all public things are JavaDoc'd?

I want to get warnings at compile time for every public thing (class, interface, field, method) which doesn't have a Javadoc comment.

How can I enable this in Eclipse?

Upvotes: 4

Views: 221

Answers (1)

Greg Case
Greg Case

Reputation: 3240

Based on your tag, I'll assume that you mean in Eclipse. To do so, Open the Window -> Preferences Menu Item, and then Under Java -> Compiler -> Javadoc, there will be a dropdown that will either let you treat missing javadoc tags as Error, Warning, or Ignore.

This answer was for the latest version of eclipse, but if you search for javadoc in the preferences search you should be able to find it easily enough.

Upvotes: 4

Related Questions