Re: good continuous integration, automatic documentation software for
c++
On Jun 4, 5:23 pm, Johnny Chang <johnny...@gmail.com> wrote:
What does this software do? I'm just looking for automatic
documentation that lets you add comments to the source code from the
webpage/wiki, not actually edit the code. I'm sorry if I've
misunderstood
Which software?
Rose generates the code framework (class definitions, bodiless
functions, etc.) from the class diagrams; you then have to add
the function bodies. I've seen it used in three different ways:
as a simple documentation tool, without any relationship to the
source code, as an interface specification tool as well, with
fully automatic generation of the header files (which were
declared as "derived" objects in the version control system, and
couldn't be manually edited), or for complete round trip
engineering, where both the sources and the headers were
generated by Rose.
CWeb is, of course, Knuth and Levy's literate programming tool.
I've extensive experience with Rose, and find it very effective,
although it can be frustrating for things best expressed in
English, rather than through diagrams. I've not enough
experience with CWeb to judge much, but I have the impression
that the problem will be just the opposite: CWeb doesn't have
any support for graphics. In addition, at least from what
little I've seen, CWeb doesn't have any provisions for round
trip engineering: in Rose, you write the function bodies
directly in C++, in your favorite editor, and Rose uses various
techniques to keep what you've added when you regenerate the
code. In CWeb, if I've understood correctly, you must either
write everything in CWeb (including the function bodies), or
loose any modifications you've made anytime you regenerate.
This would work for the model where you generate just the header
files (and they are never edited by humans), but C++ is rather
verbose, and it's nice to have the empty functions generated
automatically in the source file as well.
--
James Kanze (GABI Software) email:james.kanze@gmail.com
Conseils en informatique orient=E9e objet/
Beratung in objektorientierter Datenverarbeitung
9 place S=E9mard, 78210 St.-Cyr-l'=C9cole, France, +33 (0)1 30 23 00 34