I have typedef structs in my C++ code. As of right now they are listed as \var
typedef. Is there a better way to do this? Below is example of what I have:
/*! \var typedef etc
* \brief A type defined structure for etc
*
* \param x type- Variable declaration for x
* \param y type- Variable declaration for y
*/
I know I shouldn't even be saying param
. What else is there to use?
doxygen Getting started with doxygen Commenting your code//! //! ... text ... //! Note the 2 slashes to end the normal comment block and start a special comment block. To structure and fomat the generated documentation, Doxygen provides a large number (> 170) of special commands.
Doxytag is a small command line based utility. It can generate tag files. These tag files can be used with doxygen to generate references to external documentation (i.e. documentation not contained in the input files that are used by doxygen).
The statements in the file are case-sensitive. Comments may be placed anywhere within the file (except within quotes). Comments beginning with two hash characters ( ## ) are kept when updating the configuration file and are placed in front of the TAG they are in front of. Comments beginning with two hash characters ( ...
Doxygen (/ˈdɒksidʒən/ DOK-see-jən) is a documentation generator and static analysis tool for software source trees. When used as a documentation generator, Doxygen extracts information from specially-formatted comments within the code.
If you put the comment block in front of the typedef you don't need to use any special command.
/** This is the documentation for the following typedef */
typedef MyClass MyTypedef;
If you prefer to put it after the typedef use the following:
typedef MyClass MyTypedef;
/**< This is the documentation for the preceding typedef */
Only when the comment block must be at a different location than the actual typedef, you need to use \typedef.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With