| |
| |||||||
| Home | Register | Blogs | FAQ | Members List | Calendar | Downloads | Arcade | Mark Forums Read |
| TWARM Technical Writers Armenia. Interact with Technical Writers in Armenia. |
 |
| | LinkBack | Thread Tools | Display Modes |
Aug 13, 2004, 13:42
| #1 |
| ★★★★★★★★★★★★★  Join Date: Aug 2004 Location: ★★★★★★★★★★★★★
Posts: 16,491
Rep Power: 8 Reputation:
437 | 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 |
|   |
|
Aug 13, 2004, 14:27
| #2 |
| Administrator  Join Date: Sep 2001 Location: @work
Posts: 5,347
Rep Power: 10 Reputation:
23  | 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 ?
__________________ И повешенные могут качаться в неположенную сторону. /С.Е.Лец/ |
|
| |
|
Aug 13, 2004, 14:54
| #3 |
| ★★★★★★★★★★★★★ Join Date: Aug 2004 Location: ★★★★★★★★★★★★★
Posts: 16,491
Rep Power: 8 Reputation:
437 | 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?
__________________ Мадмазель, Медам, Месье! "Глория" меняет курс и направляется в Кейптаун! Кому это не нравится будет расстрелян на месте. (с) http://texneg.livejournal.com |
|
| |
|
Aug 16, 2004, 08:14
| #4 |
| Administrator Join Date: Sep 2001 Location: @work
Posts: 5,347
Rep Power: 10 Reputation:
23 |  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..
__________________ И повешенные могут качаться в неположенную сторону. /С.Е.Лец/ |
|
| |
Linear Mode
