JDK-4085610 : @param tags need nested @see links
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.2.0
  • Priority: P5
  • Status: Closed
  • Resolution: Duplicate
  • OS: solaris_2.6
  • CPU: generic
  • Submitted: 1997-10-11
  • Updated: 2014-05-05
  • Resolved: 1998-04-04
Related Reports
Duplicate :  
Description
When an @param tag describes a variable, it needs to link to the SET of
possible values.

For example:
      @param int color of the car @see #Colors

This would link to the collection of static finals defining colors
RED, YELLOW, GREEN, etc.

Note that if the colors are named in the param tag, they will go out
of date when the list of static finals changes. But if they are not
named at all, then the user is left to guess the values that are
intended to be used.

This must be done in conjunction with defining categories for static 
fields, bug 4085608.  (This is really a dupe of that RFE.)

Comments
EVALUATION This must be done in conjunction with defining categories for static fields, bug 4085608. (This is really a dupe of that RFE.) Therefore, I'm closing this out. doug.kramer@Eng 1998-04-03
03-04-1998