JDK-4724216 : stddoclet: Want to distinguish whether external link is to class or interface
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 6
  • Priority: P4
  • Status: Resolved
  • Resolution: Future Project
  • OS: other
  • CPU: generic
  • Submitted: 2002-08-01
  • Updated: 2014-05-05
  • Resolved: 2014-02-13
Related Reports
Relates :  
Description
When Javadoc uses -link to link to another set D of documentation, it currently
uses package-list for D to determine if a class or interface is documented 
there.  This works fine, but does not inform Javadoc as to whether it is
a class or interface.  This information could then be used to make
the interface name italic, and to describe in its link's tooltip whether
it is a class or interface, as described in RFE 4714257 "Add description 
that italics means interface for accessibility."

If Javadoc generated a class-list as follows, this would be possible:

com.package1.Class1 class
com,package1.Class2 class
com.package1.Interface1 interface

or

class com.package1.Class1
class com,package1.Class2
interface com.package1.Interface1

or use the same XML elements used in XML Doclet:

<class type="class"> com.package1.Class1 </class>
<class type="class"> com.package1.Class2 </class>
<class type="interface"> com.package1.Interface1 </class>

or use the style from the XML book file of the MIF Doclet:

<class> com.package1.Class1 </class>
<class> com.package1.Class2 </class>
<interface> com.package1.Interface1 </interface>

This last one seems the cleanest.

Perhaps there might be other benefits in having this list.

Comments
CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: mustang
14-06-2004

EVALUATION If this option is slow to generate, we might have an option to turn it off, since its function is not primary. Note that its contents are the same as allclasses-frame.html. We could possibly make this file XHTML and parse it instead. ###@###.### 2002-07-31 Because we are not sure of the solution yet, change the synopsis to state the problem we are trying to solve, from: stddoclet: Generate classes-list of all fully-qualified classes/interfaces to: stddoclet: Want to distinguish whether external link is to class or interface ###@###.### 2002-11-25
25-11-2002