Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]
Groups > comp.lang.c++ > #7606
| From | "MikeP" <mp011011@some.org> |
|---|---|
| Newsgroups | comp.lang.c++ |
| Subject | Re: Documenting C++ Code |
| Date | 2011-07-07 16:10 -0500 |
| Organization | A noiseless patient Spider |
| Message-ID | <iv57ci$3v1$1@dont-email.me> (permalink) |
| References | <KqKdnU96MLGFio7TnZ2dnUVZ_t-dnZ2d@giganews.com> <97hbruFo68U1@mid.individual.net> |
Ian Collins wrote: > On 07/ 6/11 01:52 AM, Joseph Hesse wrote: >> I am looking at tools to document C++ code and extract the >> documentation to a text or html file. >> >> So far I have looked at doxygen and autodoc. >> >> I would like to know what documentation tools you have had success >> with. > > Requirements and unit tests. If you need anything else, you are doing > something wrong! Not true. From requirements (should) come architecture and design and implementation plan, in some "physical" form (for all but the most hackish projects). Those precursory deliverables are the high-level view into the implementation. Guaranteed project failure: bring on the programmers before doing any architecting, engineering, designing, planning. That said, for understanding CodeMess (and most code is such), I use Doxygen.
Back to comp.lang.c++ | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread
Documenting C++ Code Joseph Hesse <joeh@gmail.com> - 2011-07-05 08:52 -0500
Re: Documenting C++ Code "Balog Pal" <pasa@lib.hu> - 2011-07-05 16:18 +0200
Re: Documenting C++ Code Björn Voß <bjoern.voss@iwr.uni-heidelberg.de> - 2011-07-05 16:18 +0200
Re: Documenting C++ Code Andrea Venturoli <ml.diespammer@netfence.it> - 2011-07-05 21:52 +0200
Re: Documenting C++ Code Dombo <dombo@disposable.invalid> - 2011-07-05 22:17 +0200
Re: Documenting C++ Code "Ira Baxter" <idbaxter@semdesigns.com> - 2011-07-06 19:43 -0500
Re: Documenting C++ Code Andrea Venturoli <ml.diespammer@netfence.it> - 2011-07-07 17:40 +0200
Re: Documenting C++ Code Ian Collins <ian-news@hotmail.com> - 2011-07-06 08:51 +1200
Re: Documenting C++ Code "MikeP" <mp011011@some.org> - 2011-07-07 16:10 -0500
Re: Documenting C++ Code Qi <no@no.no> - 2011-07-06 10:07 +0800
Re: Documenting C++ Code Stuart Redmann <DerTopper@web.de> - 2011-07-05 22:38 -0700
csiph-web