How to resolve At-clause should have a non-empty description? - Checkstyle - Java

java checkstyle google-style-guide
wondergoat77 picture wondergoat77 · Oct 9, 2015 · Viewed 8.9k times · Source

I am using the google java style in the checkstyle plugin for eclipse luna. Seeing this error all over my java doc but cannot seem to find how to resolve it. It's minor but its bugging me.

my javadoc:

/**
   * This is a description of something
   * 
   * @throws Exception
   */

Error is on the @throws line, Error:

At-clause should have a non-empty description

Answer

Louis Wasserman picture Louis Wasserman · Oct 9, 2015

Typically, you should write

 * @throws Exception when this exceptional condition happens

e.g.

 * @throws IllegalArgumentException when num is negative

...and generally explaining why that exception would occur.

Related questions

How to disable a particular checkstyle rule for a particular line of code?

I have a checkstyle validation rule configured in my project, that prohibits to define class methods with more than 3 input parameters. The rule works fine for my classes, but sometimes I have to extend third-party classes, which do not obey …

Read More
Checkstyle: How to Resolve "Hidden Field" Error

I am getting this checkstyle error: 'serverURL' hides a field in this private static void setServerURL(final String serverURL) { Utility.serverURL = serverURL; } What could be the reason, and how to resolve it?

Read More
Ignoring of Checkstyle warnings with annotation @SuppressWarnings

I try to ignore or disable some useless warnings in eclipse by checkstyle with annotation @SuppressWarnings like How to disable a particular checkstyle rule for a particular line of code? but this don't work for me. Here is the checkstyle.…

Read More