Eclipse Community Forums: Java Development Tools (JDT) » How to suppress javadoc compiler warning for public static attributes?

Home » Language IDEs » Java Development Tools (JDT) » How to suppress javadoc compiler warning for public static attributes?

How to suppress javadoc compiler warning for public static attributes? [message #635218]

Mon, 25 October 2010 23:51

Eclipse User

I have turned on compiler for javadoc also since I would like to maintain javadoc as in Eclipse code. I have classes that has constants (public static final) and classes that extend NLS for i18n. The attributes are public and the names are self explanatory and they do not deserve javadoc. The compiler generates warning since the attributes are public and there is no way to suppress this. Or, is there a way to suppress?

Can this be a new feature request for JDT UI?

Re: How to suppress javadoc compiler warning for public static attributes? [message #635243 is a reply to message #635218]

Tue, 26 October 2010 03:40

Eclipse User

Velganesh Subramanian wrote:
> I have turned on compiler for javadoc also since I would like to
> maintain javadoc as in Eclipse code. I have classes that has constants
> (public static final) and classes that extend NLS for i18n. The
> attributes are public and the names are self explanatory and they do
> not deserve javadoc. The compiler generates warning since the
> attributes are public and there is no way to suppress this. Or, is
> there a way to suppress?
Add @SuppressWarnings("all") before the declaration.

Dani
>
> Can this be a new feature request for JDT UI?

Re: How to suppress javadoc compiler warning for public static attributes? [message #635503 is a reply to message #635243]

Wed, 27 October 2010 03:09

Eclipse User

Is it a good practice to suppress ALL warnings? I don't think so.

I use Checkstyle to check for proper javadoc - it throws too many wanrings and my editor is filled with Checkstyle comments. I guess there is no way out.

Re: How to suppress javadoc compiler warning for public static attributes? [message #635515 is a reply to message #635503]

Wed, 27 October 2010 03:31

Eclipse User

Velganesh Subramanian wrote:
> Is it a good practice to suppress ALL warnings? I don't think so.
Well, how many other warnings do you expect on a field declaration? And
while we're at it: is it a good practice not to Javadoc your public
members? ;-)

Dani
>
> I use Checkstyle to check for proper javadoc - it throws too many
> wanrings and my editor is filled with Checkstyle comments. I guess
> there is no way out.

Re: How to suppress javadoc compiler warning for public static attributes? [message #635538 is a reply to message #635515]

Wed, 27 October 2010 05:47

Eclipse User

If you take JavaUIMessages of JDT UI plug-in as example, how much you can add for each attribute?

Previous Topic:	my problem with java
Next Topic:	Makefile for a java project

Goto Forum:

-=] Back to Top [=-

Current Time: Sat Jul 19 15:33:22 EDT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter