Re: [HACKERS] source documentation tool doxygen

the only question I have ... is there any way of improving that right
index? Love the 'detail pages', but somehow making the right index more
'tree like' might make navigation a bit easier ...

On Mon, 16 Jan 2006, 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
>>
>
> --
> Bruce Momjian | http://candle.pha.pa.us
> pgman(at)candle(dot)pha(dot)pa(dot)us | (610) 359-1001
> + If your life is a hard drive, | 13 Roberts Road
> + Christ can be your backup. | Newtown Square, Pennsylvania 19073
>
> ---------------------------(end of broadcast)---------------------------
> TIP 5: don't forget to increase your free space map settings
>

----
Marc G. Fournier Hub.Org Networking Services (http://www.hub.org)
Email: scrappy(at)hub(dot)org Yahoo!: yscrappy ICQ: 7615664