This is the mail archive of the
java@gcc.gnu.org
mailing list for the Java project.
Re: writing documentation?
- From: Tom Tromey <tromey at redhat dot com>
- To: Erik Poupaert <erik dot poupaert at chello dot be>
- Cc: java at gcc dot gnu dot org
- Date: Tue, 24 Jun 2003 07:00:46 -0600
- Subject: Re: writing documentation?
- References: <20030623132543.6155e4cb.erik.poupaert@chello.be>
- Reply-to: tromey at redhat dot com
>>>>> "Erik" == Erik Poupaert <erik.poupaert@chello.be> writes:
Erik> What documentation tools has the gcj team used for itself to
Erik> produce their documentation (rapidly)? Did it go "fast"?
For the classes we use javadoc. We haven't made any serious attempts
to extract the documentation from the source though.
For the manual itself we use texinfo, the GNU standard. texinfo is ok
(despite what you hear), but there aren't any tools to make it much
easier. Mostly it is typing; you have to know all the markup, etc.
Erik> I would appreciate, though, that all of this somehow ends up in
Erik> html and/or pdf, and things; without additional tweaking.
texinfo is ok for this. You can turn it into html, you can print it
(so postscript, I haven't tried pdf), you can turn it into info. The
auto* book was written in texinfo; also I think most books from the
GNU press are.
Tom