Re: Java class documentation

From: Peter Eisentraut <peter_e(at)gmx(dot)net>
To: <lockhart(at)fourpalms(dot)org>
Cc: <pgsql-docs(at)postgresql(dot)org>, <pgsql-jdbc(at)postgresql(dot)org>
Subject: Re: Java class documentation
Date: 2001-02-23 19:32:34
Message-ID: Pine.LNX.4.30.0102231823270.1049-100000@peter.localdomain
Views: Raw Message | Whole Thread | Download mbox
Thread:
Lists: pgsql-docs pgsql-jdbc

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(at)gmx(dot)net http://yi.org/peter-e/

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Bruce Momjian 2001-02-23 20:17:30 Re: Documentation errors in Programmers guide, chapter 4.
Previous Message Peter Eisentraut 2001-02-23 19:12:21 Re: Could not access the following URL

Browse pgsql-jdbc by date

  From Date Subject
Next Message Bob Kline 2001-02-23 20:49:32 Re: unable to find postgresql.jar
Previous Message Skidmore, Walt 2001-02-23 17:00:14 f is not a valid bitstring