Re: source documentation tool doxygen

Поиск
Список
Период
Сортировка
От Kim Bisgaard
Тема Re: source documentation tool doxygen
Дата
Msg-id 43CB9542.5080707@dmi.dk
обсуждение исходный текст
Ответ на Re: source documentation tool doxygen  (Thomas Hallgren <thomas@tada.se>)
Список pgsql-hackers
Try following the link (the Doxygen icon) - it has both a tutorial and
extensive doc.

Regards,
Kim Bisgaard

Thomas Hallgren wrote:

> I wish I've had this when I started working with PostgreSQL. This 
> looks really good. Very useful indeed, even without the comments. What 
> kind of changes are needed in order to get the comments in?
>
> Regards,
> Thomas Hallgren
>
> 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
>>
>
>
> ---------------------------(end of broadcast)---------------------------
> TIP 2: Don't 'kill -9' the postmaster
>



В списке pgsql-hackers по дате отправления:

Предыдущее
От: Thomas Hallgren
Дата:
Сообщение: Re: source documentation tool doxygen
Следующее
От: "Andrew Dunstan"
Дата:
Сообщение: Re: source documentation tool doxygen