atw: Re: C++ source code documentation
- From: "Tony Cusack" <tony@xxxxxxxxxxxxxxxx>
- To: <austechwriter@xxxxxxxxxxxxx>
- Date: Wed, 17 Dec 2003 09:17:19 +1100
Hi again,
while I was in the shower I twigged to what I was missing previously. The
problem is that whereas *\! and *\\ are multi-line comment delimiters, and
have corresponding closing delimiters (!\* and \\* ), *\ is a single line
comment which relies on the end of line character for a closing delimiter.
This is definitely a task for a regex tool such as Funduc S&R - in fact if
you send me some sample code I'll figure out the expression -
tony@xxxxxxxxxxxxxxxxx But it seems strange to me that Doxygen won't pick up
the end of line character(s).
rgds,
Tony.
-----Original Message-----
From: austechwriter-bounce@xxxxxxxxxxxxx
[mailto:austechwriter-bounce@xxxxxxxxxxxxx] On Behalf Of Tony Cusack
Sent: Wednesday, 17 December 2003 8:20 AM
To: austechwriter@xxxxxxxxxxxxx
Subject: atw: Re: C++ source code documentation
Hi Margaret,
I haven't worked with C++ but I'd tackle this sort of problem myself with
Funduc Search and Replace, available for about $US30 from
http://www.funduc.com/ This tool puts a very useable GUI on top of extended
search & replace functionality, including regular expressions. I'd recommend
getting the wizard as well, an extra $10.
Mind you I can't see, from what you've told us, why you can't just globally
replace the problematic delimiters with the one you want anyway - but I'm
sure I'm missing something.
Marking up your comments in XML would certainly make it amenable to a much
broader range of tools & processing possibilities than the standard
delimiters. But you would need to have some XSLT expertise available to take
advantage of that. So if you've already got Doxygen I guess that's the
easiest way to go.
rgds,
Tony.
-----Original Message-----
From: austechwriter-bounce@xxxxxxxxxxxxx
[mailto:austechwriter-bounce@xxxxxxxxxxxxx] On Behalf Of Margaret Parker
Sent: Wednesday, 17 December 2003 1:41 AM
To: austechwriter@xxxxxxxxxxxxx
Subject: atw: C++ source code documentation
Has anyone on the list any experience in extracting documentation from C++
source code?
I'm looking for recommendations/suggestions for a tool that can produce
something like JavaDoc, but for C++ (users are developers), and it needs to
be tweakable to account for local idiosyncrasies in comment entries.
Doxygen is the closest I've found to what I need so far, but comments are my
problem - the comments in our code don't quite match Doxygen's parsing
capabilities - as far as I can work out, Doxygen will only find *\! or *\\
and won't recognise just *\ as the beginning of a comment.
I'd like something I could configure to recognise this, without resorting to
building a new tool altogether.
I can get new source code done with the appropriate commenting style, but
the legacy stuff has me a bit stumped. Short of going through all the source
files and changing the comment tags myself, before running them through
doxygen, I can't see a quick way around it.
The problem will be around for another year or so, before a new environment
with built-in doco extraction tools is available.
If I'm going to end up going through the source code anyway, would it be
more sensible to add in xml tags, and if so, how can I then extract them?
I'm not really a developer myself, although I'd be willing to have a go at
scripting something if it looked like saving me time.
Any advice or suggestions would be appreciated.
Cheers
Margaret
**************************************************
To post a message to austechwriter, send the message to
austechwriter@xxxxxxxxxxxxxx
To subscribe to austechwriter, send a message to
austechwriter-request@xxxxxxxxxxxxx with "subscribe" in the Subject field.
To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx with
"unsubscribe" in the Subject field.
To search the austechwriter archives, go to
www.freelists.org/archives/austechwriter
To contact the list administrator, send a message to
austechwriter-admins@xxxxxxxxxxxxx
**************************************************
**************************************************
To post a message to austechwriter, send the message to
austechwriter@xxxxxxxxxxxxxx
To subscribe to austechwriter, send a message to
austechwriter-request@xxxxxxxxxxxxx with "subscribe" in the Subject field.
To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx with
"unsubscribe" in the Subject field.
To search the austechwriter archives, go to
www.freelists.org/archives/austechwriter
To contact the list administrator, send a message to
austechwriter-admins@xxxxxxxxxxxxx
**************************************************
**************************************************
To post a message to austechwriter, send the message to
austechwriter@xxxxxxxxxxxxxx
To subscribe to austechwriter, send a message to
austechwriter-request@xxxxxxxxxxxxx with "subscribe" in the Subject field.
To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx with
"unsubscribe" in the Subject field.
To search the austechwriter archives, go to
www.freelists.org/archives/austechwriter
To contact the list administrator, send a message to
austechwriter-admins@xxxxxxxxxxxxx
**************************************************
Other related posts:
