doxygen and C or C++ comment blocks
Hi, all.
I am interested in improving our communication with engineers through the source code, because it helps to reduce the communication gap and let the writers put more focus on the code examples in the docs, because customers usually do not care about the internals, just results!
My question is about the tools that can help segregate the documentation comments in the C or C++ source code for different users. [ put another way - if you are going to use auto-generated information directly from the code, you must make it clear what is end-user-level information (that is, for user of the end product), what is user-level information (that is, for developers of the product), and what is 'internal' to software ] .
Yes, I have tried Doxygen-style tags and documents, and they look impressive - until you try to use them 'for real'; and then I find them lacking, and have to resort to reading the code and headers in an editor.
Any tools that can help segregate the comment blocks in the source code?!
Thanks much!
__________________
Мадмазель, Медам, Месье! "Глория" меняет курс и направляется в Кейптаун! Кому это не нравится будет расстрелян на месте. (с)
http://texneg.livejournal.com
|