API writers - a question about managing/presenting information in a single source environment
Tom Mathieu
tmathieu at us.ibm.com
Mon Nov 12 09:50:48 MST 2007
I write API documentation (developer's guides) for IBM components.
To date, I take the developer's rough drafts of the javadoc and create an
MS-Word-based developer's guide that "augments" the javadoc with
class/method descriptions of the classes and methods. The developers then
cut and paste my text into the java source files (javadoc comments).
We're looking for ways to reduce this replication of efforts. The
developers have agreed to provide me with access to the java source so
that I can create/modify the javadoc comments, directly.
But, I want to provide our customers with both online and offline access
to the information (online access would be to the javadoc files in a
browser, and offline access would be provided by a PDF of the javadoc that
also contains more information, like examples/tutorials, etc). Are any of
you aware of a tool that will extract javadoc html and convert it to a
printable/viewable PDF file, preserving the links, class hierarchy, index,
and so on?
Thanks,
Tom Mathieu
More information about the STC-Austin-general
mailing list