Re: source documentation tool doxygen - Mailing list pgsql-hackers

From Bruce Momjian
Subject Re: source documentation tool doxygen
Date
Msg-id 200601162332.k0GNW7D28523@candle.pha.pa.us
Whole thread Raw
In response to source documentation tool doxygen  (Joachim Wieland <joe@mcknight.de>)
Responses Re: [pgsql-www] source documentation tool doxygen
Re: [pgsql-www] source documentation tool doxygen
Re: source documentation tool doxygen
List pgsql-hackers
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@mcknight.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
>

--
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073

pgsql-hackers by date:

Previous
From: Joachim Wieland
Date:
Subject: Re: source documentation tool doxygen
Next
From: "Marc G. Fournier"
Date:
Subject: Re: [pgsql-www] source documentation tool doxygen