Java Solaris Communities Sun Store Join SDN My Profile Why Join?
 
Bug Database
Bug Detail
Quick Lists
Top 25 Bugs
Top 25 RFE's
Recently Closed Bugs
Printable Page Printable Page


Bug Database
Bug ID: 4359470
Votes 1
Synopsis javadoc tool: Modify Comment.java for easy writing of custom tags
Category doclet:tbd
Reported Against 1.2 , 1.2beta2 , 1.2beta3
Release Fixed
State 11-Closed, duplicate of 4282805, request for enhancement
Priority: 4-Low
Related Bugs 4282805 , 4102647
Submit Date 04-AUG-2000
Description
Modify javadoc so that users can create custom tags without modifying 
the standard doclet.

A developer has submitted the working code for this, for us
to incorporate.  However, his code works only for inline tags.
We should modify it to work for normal tags as well.
One question:  Is his implementation the best approach?
Someone else has suggested a "listener" interface.

Here are his instructions:

A new Comment.class overrides the class file of the same name in the javadoc package.  Comment.java has been modified to include hooks to a new
class CustomTagFactory. 

To add a new inline tag you need to to the following...

1       Create a factory class for your tag class.
        Derive your factory from interface CustomTagFactoryImpl.

2       Create you tag class.
        A handy base class CustomTagImpl (based on TagImpl) is provided for  
        this.

3       All extension classes must be registered in a file called     
        javadocplugin/resources/customtag.properties.
        The classpath will be searched for this file.
        It expected to find lines like ...

        javadoc.tag.custom.inline=javadocplugin.CustomTagFactory_mltag

        ... one line for each custom class. the path to your custom class is 
        relative to the classpath.
Work Around
N/A
Evaluation
Jamie, this seems like a dupe of bug 4395777 "Tag listener interface".  
Would you please evaluate this and merge the two if necessary?
  xxxxx@xxxxx   2000-12-08

This is a duplicate of 4282805, which has been fixed.
  xxxxx@xxxxx   2001-06-27
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang