Re: source documentation tool doxygen

Поиск
Список
Период
Сортировка
От Joachim Wieland
Тема Re: source documentation tool doxygen
Дата
Msg-id 20060116230419.GA2524@mcknight.de
обсуждение исходный текст
Ответ на Re: source documentation tool doxygen  (Michael Glaesemann <grzm@myrealbox.com>)
Список pgsql-hackers
On Tue, Jan 17, 2006 at 06:51:15AM +0900, Michael Glaesemann wrote:
> I haven't looked at it yet, but might there not be a way to have a
> preprocessing step where the current comment format is converted to
> something doxygen-friendly? pg_indent2doxygen or something? Then the
> current comment style could be maintained and doxygen could get what
> it likes.

It's not about getting in all the comments, it's mostly about comments
describing functions / makros / typedefs / structures / global variables
and the like.

Comments in function bodies will just stay I guess.

However we could try to find some de facto rules about comments to get most
of the matches: For example a comment starting on column 0 of the line is
probably one you're looking for vs. one that has some whitespace at the
beginning is not.

Of course this would still need manual review for every file.


Joachim

--
Joachim Wieland                                              joe@mcknight.de
C/ Usandizaga 12 1°B                                           ICQ: 37225940
20002 Donostia / San Sebastian (Spain)                     GPG key available


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

Предыдущее
От: Tom Lane
Дата:
Сообщение: Re: ScanKey representation for RowCompare index conditions
Следующее
От: Bruce Momjian
Дата:
Сообщение: Re: source documentation tool doxygen