public inbox for [email protected]  

help / color / mirror / Atom feed

From: Joachim Wieland <[email protected]>
To: Michael Glaesemann <[email protected]>
Cc: Tom Lane <[email protected]>
Cc: Neil Conway <[email protected]>
Cc: Andrew Dunstan <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Subject: Re: source documentation tool doxygen
Date: Tue, 17 Jan 2006 00:04:19 +0100
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>
	<[email protected]>
	<[email protected]>
	<[email protected]>
	<[email protected]>

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                                              [email protected]
C/ Usandizaga 12 1°B                                           ICQ: 37225940
20002 Donostia / San Sebastian (Spain)                     GPG key available

view thread (20+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected]
  Subject: Re: source documentation tool doxygen
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox