473,508 Members | 2,088 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

Customizing Doxygen C++ Documentation

2 New Member
Hi all,

I have a big C++ project, and I used my own way of commenting the functions and the header file. Here is an example of one of my commented function

Expand|Select|Wrap|Line Numbers
  1.  /*============================================ 
  2. Method :mAddAKid.
  3. Description :Add a kid to the Queue.
  4. Note : None.
  5. ----------------------------------------------------------
  6. Parameter :
  7. Name I/O Description
  8. pName I Name of the kid being added. 
  9. pIsABoy I True if its a boy, false if its a girl
  10. =============================================*/
  11. void ClassA::mAddAKid( void pName, bool pIsABoy )
  12. {
  13. // Code...
  14.  
  15. }
  16.  
Now the question is :confused:

Can i configure Doxygen to be able to read these comments and generate me some nice documentation (all I need is HTML)


Any help will be greatly appriciated. :)

maldini
Dec 15 '05 #1
2 3546
Niheel
2,456 Recognized Expert Moderator Top Contributor
I looked around the manual, but couldn't find any information about customization you might check the mail archive though.

Seem's like a good program, i've never used it.
Dec 16 '05 #2
maldini
2 New Member
I have done some research myself, (in the manual) thanks for that!!!!
And I think I have reached the conclusion that it is imposible to do so!!!

I guesss I will write a small parser to translate my comments in Doxygen style comments.

Thank for the help
Dec 20 '05 #3

Sign in to post your reply or Sign up for a free account.

Similar topics

10
10363
by: Erwin Burgstaller | last post by:
When I have several header files with "namespace x {}" in each, the resulting doxygen documentation lists the Namespace exactly as often as there are header files with that namespace in. Thats only...
0
1514
by: rcoutts | last post by:
I'm using Doxygen for the first time and really impressed with how simple it is to use and how elegant the output is. The only problem I'm having is trying to figure out how to shut off the...
3
4481
by: Bob Johnson | last post by:
I have looked through the docs for the XML documentation tags in the C# Programmer's Reference, and I haven't come across a "MAINPAGE" tag like you find in Doxygen. This tag is nice for when you...
2
2083
by: David Dvali | last post by:
Hello. What is Doxygen tagging and how it can be used for source code documenting?
6
3305
by: Gabriel Zachmann | last post by:
Is there a way to combine doxygen comments, like this one ## Documentation for a function. # @var a - variable # More details. def func( a ): pass
0
1581
by: Let_Me_Be | last post by:
Hi, helping our C/C++ teacher and would like to modify the curent website of this two classes. What I would like to include is doxygen generated documentation for stl classes (and link it with...
6
4834
by: Ivan Vecerina | last post by:
What tagged comment syntax do you use to document C++/CLI code ? As far as I know, doxygen does not currently support C++/CLI. Are there other/similar tools? Does Microsoft provide an equivalent...
2
17126
by: Peter Olcott | last post by:
http://www-scf.usc.edu/~peterchd/doxygen/ The above is an example of what the output should look like. I ran Doxygen on a simple program that I wrote to test Doxygen, and all of the Call Graph...
7
3212
by: PeteOlcott | last post by:
So far I can only get Doxygen to generate callergraphs for ALL functions or for NO functions, Doxygen seems to be ignoring the \callergraph command. Does anyone know how to limit Doxygen to...
0
7385
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...
1
7046
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
0
7498
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each...
0
5629
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...
0
4707
by: conductexam | last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and...
0
3195
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The...
0
3182
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
1
766
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.
0
418
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.