Re: [HACKERS] source documentation tool doxygen

This was my plan all along, just been waiting for someone to make it work with
the postgresql code and then send instructions to the postgresql web team on
how to set it up.

Robert Treat

On Monday 16 January 2006 18:32, Bruce Momjian wrote:
> Wow, looks great. Is that URL stable? Can we link to it from the
> PostgreSQL developers page?
>
> http://www.postgresql.org/developer/coding
>
> ---------------------------------------------------------------------------
>
> Joachim Wieland wrote:
> > I've created a browsable source tree "documentation", it's done with the
> > doxygen tool.
> >
> > http://www.mcknight.de/pgsql-doxygen/cvshead/html/
> >
> > There was a discussion about this some time ago, Jonathan Gardner
> > proposed it here:
> >
> > http://archives.postgresql.org/pgsql-hackers/2004-03/msg00748.php
> >
> > quite a few people found it useful but it somehow got stuck. The reason
> > was apparently that you'd have to tweak your comments in order to profit
> > from it as much as possible.
> >
> > However I still think it's a nice-to-have among the online documentation
> > and it gives people quite new to the code the possibility to easily check
> > what is where defined and how... What do you think?
> >
> > doxygen can also produce a pdf but I haven't succeeded in doing that so
> > far, pdflatex keeps bailing out. Has anybody else succeeded building this
> > yet?
> >
> >
> >
> > Joachim
> >
> > --
> > Joachim Wieland
> > joe(at)mcknight(dot)de C/ Usandizaga 12 1?B
> > ICQ: 37225940 20002 Donostia / San Sebastian (Spain)
> > GPG key available
> >
> > ---------------------------(end of broadcast)---------------------------
> > TIP 3: Have you checked our extensive FAQ?
> >
> > http://www.postgresql.org/docs/faq

--
Robert Treat
Build A Brighter Lamp :: Linux Apache {middleware} PostgreSQL