-
Enhancement
-
Resolution: Fixed
-
P5
-
1.1, 1.2.0
-
beta
-
generic
-
generic, solaris_2.5.1
The "-doctype MIF" option, which generated FrameMaker intermediate files (called MIF), was in Javadoc 1.0 and removed from javadoc as of JDK1.1. This functionality should be restored, possibly time through the use of the HotJava class library. See the "Comments" for the background and suggestions on how to reimplement this feature.
Specification:
Doug has written a specification for the MIF doclet at:
http://javaweb.eng/~dkramer/javadoc/mifdoclet-spec.html
Justification:
The MIF doclet needs to be flexible, since it is needed by several groups:
- Guy Steele to generate the class API chapters of the Java
Language Specification (chapters 20-22 in 1st Edition), for java.lang,
java.reflect and java.ref. This enables the source code doc comments
to the be master source for all API specs (rather than Framemaker files).
- Jonathan Gibbons of JCK team to include API docs with other FrameMaker
docs
- Graham Hamilton to include API specs with Bean spec (written in FrameMaker)
- JDK docs team to duplicate the current standard doclet functionality in
MIF so that it can be generated in PostScript and PDF.
To get this variety, perhaps we could implement a mif package that contains
the abstracted behavior common to all mif doclets, then a standardmif
doclet to duplicate the standard doclet, a jckmif doclet for the JCK team,
a jlsmif doclet for the JLS book, and so forth.
Specification:
Doug has written a specification for the MIF doclet at:
http://javaweb.eng/~dkramer/javadoc/mifdoclet-spec.html
Justification:
The MIF doclet needs to be flexible, since it is needed by several groups:
- Guy Steele to generate the class API chapters of the Java
Language Specification (chapters 20-22 in 1st Edition), for java.lang,
java.reflect and java.ref. This enables the source code doc comments
to the be master source for all API specs (rather than Framemaker files).
- Jonathan Gibbons of JCK team to include API docs with other FrameMaker
docs
- Graham Hamilton to include API specs with Bean spec (written in FrameMaker)
- JDK docs team to duplicate the current standard doclet functionality in
MIF so that it can be generated in PostScript and PDF.
To get this variety, perhaps we could implement a mif package that contains
the abstracted behavior common to all mif doclets, then a standardmif
doclet to duplicate the standard doclet, a jckmif doclet for the JCK team,
a jlsmif doclet for the JLS book, and so forth.
- duplicates
-
JDK-4124050 Request option to omit header and footer navigation tables
- Closed
- relates to
-
JDK-4034280 Allow package-level comments in topmost packages.html file
- Closed
-
JDK-4034228 stddoclet: Add @index doc-comment tag for generating an index from common words
- Closed
-
JDK-4034233 Add @xref doc-comment tag (similar to @link)
- Closed
-
JDK-4034242 Add @footnote and @footnoteref doc-comment tags
- Closed
-
JDK-4037336 Add RTF output option
- Closed
(1 relates to)