Armenian Knowledge Base  

Go Back   Armenian Knowledge Base > Entertainment > Literary nook > TWARM
Register

Reply
 
LinkBack Thread Tools
Old 13.08.2004, 14:42   #1
★★★★★★★★★★★★★
 
Hrach_Techie's Avatar
 
Join Date: 08 2004
Location: London, UK
Age: 38
Posts: 16,531
Downloads: 8
Uploads: 0
Reputation: 482 | 6
Default 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
Reply With Quote
Old 13.08.2004, 15:27   #2
Академик
 
greka's Avatar
 
Join Date: 09 2001
Location: inside myself
Posts: 5,369
Downloads: 0
Uploads: 0
Reputation: 18 | 5
Default

what's the meaning of the sentence:
"to segregate the comment blocks in the source code" ?
could you please bring an example source code before and after segregating ?
Reply With Quote
Old 13.08.2004, 15:54   #3
★★★★★★★★★★★★★
 
Hrach_Techie's Avatar
 
Join Date: 08 2004
Location: London, UK
Age: 38
Posts: 16,531
Downloads: 8
Uploads: 0
Reputation: 482 | 6
Default

Hey Greco El!

What I mean is I need something that has the ability to generate internal (for programmers who maintain the code) and external (for the end users of SDK) documentation from the same set of comments.

I know docjet has this capability - but it's not free as far as I know .... or I am wrong?
Reply With Quote
Old 16.08.2004, 09:14   #4
Академик
 
greka's Avatar
 
Join Date: 09 2001
Location: inside myself
Posts: 5,369
Downloads: 0
Uploads: 0
Reputation: 18 | 5
Default

such tool was out of use for me, and i'm not aware on anything like that but Java compilers.
Documenting is a real pain, sure..
Reply With Quote
Sponsored Links
Reply

Thread Tools


На правах рекламы:
реклама

All times are GMT. The time now is 23:16.


Powered by vBulletin® Copyright ©2000 - 2017, Jelsoft Enterprises Ltd.