Re: Java class documentation - Mailing list pgsql-docs

From Peter Eisentraut
Subject Re: Java class documentation
Date
Msg-id Pine.LNX.4.30.0102231823270.1049-100000@peter.localdomain
Whole thread Raw
In response to Re: Java class documentation  (Thomas Lockhart <lockhart@alumni.caltech.edu>)
List pgsql-docs
Thomas Lockhart writes:

> > Could we for now remove the formal class documentation from the DocBook
> > source, while keeping the narrative parts, and instead point people to the
> > JavaDoc?  Could we make prebuild class documentation in HTML available to
> > users, maybe where the jars are downloaded?
>
> Works for me. Not sure if we have rules for building javadoc in our
> makefiles, but I'm sure it would be easy to add if necessary. Peter M,
> what do you think?

Actually, writing a simplistic javadoc to docbook converter ("doclet")
turned out to be rather easy.  I can create <refentry> pages for the
relevant classes and put them where the current text is.

The result is a bit ugly, actually, because javadoc does not have the rich
structure that docbook has, while none of docbook's structure actually
matches the javadoc format, so it would still be of interest to have the
full javadoc/html set available.

--
Peter Eisentraut      peter_e@gmx.net       http://yi.org/peter-e/


pgsql-docs by date:

Previous
From: anton@hesiod.org
Date:
Subject: web page search
Next
From: Peter Eisentraut
Date:
Subject: Re: Could not access the following URL