RE: help with doxygen
- From: "Sina Bahram" <sbahram@xxxxxxxxx>
- To: <programmingblind@xxxxxxxxxxxxx>
- Date: Mon, 1 Oct 2007 15:50:23 -0400
You would put the declaration level documentation with the prototypes which
should all be in your .h
The class level documentation as well would go in the .h; for the same
reason.
Take care,
Sina
-----Original Message-----
From: programmingblind-bounce@xxxxxxxxxxxxx
[mailto:programmingblind-bounce@xxxxxxxxxxxxx] On Behalf Of Marlon Brandão
de Sousa
Sent: Monday, October 01, 2007 2:49 PM
To: programmingblind@xxxxxxxxxxxxx
Subject: Re: help with doxygen
Ok, I am even more confused now.
Everything I would like to do is the following:
Class a his used for blablabla.
methods
a() constructor
b(int c, float d) does something.
Parameters
c integer that is used for something
d float that is used for another thing
returns a double
...
And so on with all the methods and properties. I can describe easily what
each method do, what they take and what they return. What kind of
documentation I should put in each file? I mean what should go in the cpp
and in the .h? I am not asking about what tags I should use, only about what
needs to be in the cpp and in the .h files.
Marlon
2007/10/1, Sina Bahram <sbahram@xxxxxxxxx>:
> Both
>
> You can honestly never have too much documentation, as long as it's
> nicely done, coherantly written, and nontrivial.
>
> Take care,
> Sina
>
> -----Original Message-----
> From: programmingblind-bounce@xxxxxxxxxxxxx
> [mailto:programmingblind-bounce@xxxxxxxxxxxxx] On Behalf Of Marlon
> Brandão de Sousa
> Sent: Monday, October 01, 2007 1:09 PM
> To: programmingblind@xxxxxxxxxxxxx
> Subject: help with doxygen
>
> Hello,
> I am trying to use doxygen to document a class. My question is what
> file should I document the .cpp or the .h file?
> I would preffer to document the cpp file but I am not sure about what
> doxygen expects.
> Thanks
> Marlon
> --
> When you say "I wrote a program that crashed Windows," people just
> stare at you blankly and say "Hey, I got those with the system, for free."
> Linus Torvalds
> __________
> View the list's information and change your settings at
> //www.freelists.org/list/programmingblind
>
> __________
> View the list's information and change your settings at
> //www.freelists.org/list/programmingblind
>
>
--
When you say "I wrote a program that crashed Windows," people just stare at
you blankly and say "Hey, I got those with the system, for free."
Linus Torvalds
__________
View the list's information and change your settings at
//www.freelists.org/list/programmingblind
__________
View the list's information and change your settings at
//www.freelists.org/list/programmingblind
Other related posts:
