atw: Re: C++ source code documentation
- From: "Bridget Knaus" <bridget.knaus@xxxxxxxxxxxxxx>
- To: <austechwriter@xxxxxxxxxxxxx>
- Date: Wed, 17 Dec 2003 08:16:09 +1100
Margaret
You might like to ask this question on the nettechwriters list. It's a
very helpful group of people who do exactly this kind of work. To
subscribe, send a blank email to
nettechwriters-subscribe@xxxxxxxxxxxxxxxx They are US based so a reply
may take a day or so.=20
One of the members of that list has done a comparison of autodoc tools
and the results are at
http://www.hypertextnavigation.com/autodoctools.htm that might be of use
to you.
We use Doxygen and, between myself and the developers, have got it to
work pretty well on C++ code. The developers have looked after the code
side of it though. Can you do some sort of search and replace on your
comment tags?
Regards
Bridget Knaus
Technical Communications=20
Softlaw Corporation Limited
www.softlaw.com.au
Phone +61 2 6270 3200
Facsimile +61 2 6270 3299
=20
The views expressed in this message are those of the sender. The sender
in no way purports to represent the views of SoftLaw or its employees.
=20
-----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
**************************************************
Other related posts:
