#54 Unused @throws tag for exception subclas

release_3.1
closed
Check (274)
2
2012-10-10
2002-04-07
iammichael
No

Subclasses of a declared exception may be documented
to describe the exact types of exceptions that may be
thrown. For example, a method may declare that it
throws IOException, and in the API documentation, it
may have javadoc for FileNotFoundException in addition
to the IOException. FileNotFoundException is reported
as an unused exception.

Any exception that is a subclass of a documented
exception should not be reported as an Unused
exception.

[note: reporting against release 2.1, but there isn't
a 2.1 group]

Discussion

  • Logged In: YES
    user_id=746148

    committed in the CVS.
    new option allowThrowsTagsForSubclasses added

     
  • Logged In: YES
    user_id=746148

    new option allowThrowsTagsForSubclasses added to
    JavadocMethodCheck. Changes committed in the CVS.