United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
JDK-4074202 : stddoclet: put exception class link in throws section even if no text

Details
Type:
Enhancement
Submit Date:
1997-08-25
Status:
Closed
Updated Date:
2014-05-05
Project Name:
JDK
Resolved Date:
2001-08-07
Component:
tools
OS:
solaris_2.5.1
Sub-Component:
javadoc(tool)
CPU:
sparc
Priority:
P5
Resolution:
Fixed
Affected Versions:
1.2.0
Fixed Versions:
1.4.0 (beta2)

Related Reports

Sub Tasks

Description
When an @exception tag has an exception class name but no explanatory text, 
javadoc throws a warning message but doesn't place anything pertaining to 
the exception in the html file.

It would be better if, in addition to issuing a warning, javadoc placed the 
a link to the exception class in the html file, even if the @exception tag 
doesn't have a text explanation.

                                    

Comments
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
merlin-beta2

FIXED IN:
merlin-beta2

INTEGRATED IN:
merlin-beta2

VERIFIED IN:
merlin-rc1


                                     
2004-06-14
PUBLIC COMMENTS

This bug has been fixed.  An exception class link is now generated in the 
throws section in either of two cases:
    (1) there a @throws tag but no text accompanies the tag               
    (2) if an exception is declared but there is no @throws tag

jamie.ho@Eng 2001-07-18
                                     
2001-07-18
EVALUATION

Probably should place in throws section if exception is thrown but there is
no tag at all.
robert.field@Eng 1998-07-06

I have verified that the @throws appears in the API output, both for the 1.3.1
javadoc and the one to appear in 1.4.  Therefore this must be a standard doclet
issue.

neal.gafter@Eng 2001-02-27

The original request is different from what Robert is asking for above.
This boils down to a request to add an exception class link in the 
throws section in either of two cases:
    (1) there a @throws tag but no text accompanies the tag               
    (2) if an exception is declared but there is no @throws tag
Neal says above that the second case can be done.

doug.kramer@Eng 2001-06-29

This bug has been fixed.  Location of fix:

src/share/classes/com/sun/tools/doclets/standard/ConstructorSubWriter.java
src/share/classes/com/sun/tools/doclets/standard/ExecutableMemberSubWriter.java
src/share/classes/com/sun/tools/doclets/standard/MethodSubWriter.java
jamie.ho@Eng 2001-07-18
                                     
2001-07-18



Hardware and Software, Engineered to Work Together