Postgres Pro
Downloads
Home   >   mailing lists

Thread: Documentation PostgreSQL-specific JDBC methods

Documentation PostgreSQL-specific JDBC methods

From
Peter Eisentraut
Date:
The Programmer's Guide section 8.6 documents PostgreSQL-specific
extensions to the JDBC standard, such as the large object and the fastpath
interfaces.  Right now most of this is just one big monospaced environment
with ASCII markup.  I've tried to convert some of this to real DocBook
markup in the past, but this process was just tiresome because the
structure of the documentation could not be rendered very well in DocBook.

I think this could probably be done better by generating this material
directly with Javadoc and putting an external link in the DocBook-based
documentation.

Comments?

--
Peter Eisentraut   peter_e@gmx.net   http://funkturm.homeip.net/~peter

Re: Documentation PostgreSQL-specific JDBC methods

From
Barry Lind
Date:
Peter,

Yes I agree.  When you suggest putting an 'external link', what do you
mean by external?  Does external mean a link to jdbc.postgresql.org web
site where the javadoc would be hosted, or a link to some html javadoc
generated files that are part of the distribution?

thanks,
--Barry

Peter Eisentraut wrote:

> The Programmer's Guide section 8.6 documents PostgreSQL-specific
> extensions to the JDBC standard, such as the large object and the fastpath
> interfaces.  Right now most of this is just one big monospaced environment
> with ASCII markup.  I've tried to convert some of this to real DocBook
> markup in the past, but this process was just tiresome because the
> structure of the documentation could not be rendered very well in DocBook.
>
> I think this could probably be done better by generating this material
> directly with Javadoc and putting an external link in the DocBook-based
> documentation.
>
> Comments?
>
>

Re: Documentation PostgreSQL-specific JDBC methods

From
Peter Eisentraut
Date:
Barry Lind writes:

> Yes I agree.  When you suggest putting an 'external link', what do you
> mean by external?  Does external mean a link to jdbc.postgresql.org web
> site where the javadoc would be hosted, or a link to some html javadoc
> generated files that are part of the distribution?

The latter.  (The "external link" would be external to the DocBook realm.)
The files could go under $(docdir)/html/javadoc.  If someone wants to work
on this, you're welcome.  Otherwise I might get to it sometime.

--
Peter Eisentraut   peter_e@gmx.net