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: 4034052
Votes 2
Synopsis stddoclet: Restore the -doctype MIF option
Category doclet:tbd
Reported Against 1.1 , 1.2 , 1.2beta2
Release Fixed 1.4(merlin-beta)
State 10-Fix Delivered, request for enhancement
Priority: 5-Very Low
Related Bugs 4034228 , 4034233 , 4034242 , 4034280 , 4037336 , 4124050
Submit Date 24-FEB-1997
Description
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.
Work Around
 
Evaluation
We need to do this MIF doclet, and can do it after the standard doclet 
code freeze.
  xxxxx@xxxxx   1998-04-03

The MIF Doclet is almost ready for the fourth relase so far. Recently, we have been facing few problems with "Windows version of the fmbatch - dzbatcher". Once we get around with that, we can definitely go ahead and fix this bug.
  xxxxx@xxxxx   2000-03-07

This bug has been fix through the inplementation of the MIF doclet.

  xxxxx@xxxxx   2001-02-26
Comments
  
  Include a link with my name & email   

Submitted On 29-JAN-1999
moconnel
Has there been any work on the MIF doclet.  I'd
certainly like to have it here.
moconnel@asc.corp.mot.com


Submitted On 21-MAY-1999
barbarasamson
I also need to generate an MIF document from my javadoc comments.


Submitted On 06-MAR-2000
dkramer
This is Doug Kramer from the Javadoc team at Sun.  We have
written the MIF doclet, and it is at: 
http://java.sun.com/javadoc/mifdoclet

doug.kramer@sun.com



PLEASE NOTE: JDK6 is formerly known as Project Mustang