-
Notifications
You must be signed in to change notification settings - Fork 14
Documentation Style
doe300 edited this page Jun 16, 2015
·
1 revision
We use the Qt documentation style in combination with the doxygen documentation generation program.
Here are some examples for correct documentation:
//! This is a brief class description.
/*!
* A more elaborate class description.
*/
class Test
{
public:
//! A constructor.
/*!
* A more elaborate description of the constructor.
*/
Test();
//! A destructor.
/*!
* A more elaborate description of the destructor.
*/
~Test();
//! A normal member taking two arguments and returning an integer value.
/*!
* \param name The description of the parameter
* \param s a constant character pointer.
* \return The test results
* \sa This is a synonym for the @see-clause, resulting in links to listed methods
*/
int testMe(int a,const char *s);
//! A pure virtual member.
/*!
* \sa testMe()
* \param c1 the first argument.
* \param c2 the second argument.
*/
virtual void testMeToo(char c1,char c2) = 0;
//! A public variable.
/*!
* Details.
*/
int publicVar;
//! A function variable.
/*!
* Details.
*/
int (*handler)(int a,int b);
};
For more commands supported by doxygen, see Doxygen Commands