[Discuss] doxygen

Stephen Adler adler at stephenadler.com
Tue Jul 5 21:27:44 EDT 2011


Guys,

I want to use an automated web'izing documentation tool like doxygen for 
a software project I'm working on. I'm wondering what's the use case for 
this is. What I mean by use case is the way one adds the html generation 
into the software development cycle. This question may be too simplistic 
but maybe there are some general rules which would make life easy for me 
that I wouldn't think of when I start using a tool like doxygen. For 
example, does one only generate html documentation output when one 
prepares the code for a release or version tag? Does one include a 
documentation target in the make file so one can type 'make 
documentation' How often do you generate the documentation? After each 
make? etc. etc. If there is a web resource I should read through, I'd 
greatly appreciate the url and any comments you guys may have.

Thanks. Steve.




More information about the Discuss mailing list