TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
> [mailto:bounce-techwr-l-9798 -at- lists -dot- raycomm -dot- com]On Behalf Of Benzi
> Sent: Monday, March 06, 2000 11:37 AM
> To: TECHWR-L
> Cc: techwhirl
> Subject: RE: exporting Javadoc
> Hi Barbara:
> Thanks for your detailed reply.
> A member of our team found a reference to an "MIF Doclet" on
>http://developer.java.sun.com/developer/products/mifdoclet/. They claim it
> lets you generate MIF files from the Javadoc, and you can open these in
> Frame (and convert them to RTF, PDF, or whatever). Sounds too good to be
> true. I wonder how much tweaking of the Frame files you need to do.
> Have you tried this? (We're still waiting for our Frame to arrive, so we
> can't experiment at the moment....)
I too have been struggling with documenting a Java API and came across the
MIF doclet not too long ago. It took quite a lot of effort to get it to
work. I first started running it on the Sun system on which the source code
resides and eventually gave up -- I could get Javadoc to work but the doclet
would produce only error messages. Finally, I transferred the source to my
PC, installed the JDK and the doclet, and got it to run without too much
trouble. I was worried about a really long command line being a limitation
under NT (I run it as a batch file) but so far it's been OK.
The output is a slightly limited subset of the full Javadoc output. The
default format is serviceable but should be modifiable by editing the
templates that come with the doclet. That's the next thing I have to do, but
I don't expect it will present any major problems.