defuze.me
Client
|
The better way to learn is certainly to:
To document a namespace, class, method, attribut, ... you have to put a doxygen-style comment before the element.
/** This is a brief description ending with a dot. * This is a more detailled description. * This description will automatically be associated to the class below. **/ class MyClass { ... }
The first sentence of the description (until the first '.') is the brief description. It's important to provide it.
If your description is short, you can use the following syntax:
int myMethod(); ///< The brief description.
You can use a lot of doxygen or html commands to personnalize the output. Here are some commonly used:
Here's a list: - Elem 1 - Elem 2 - Sub Elem 1 \n Insert a new line \params param_name param description Describe an parameter \return return value description Describe the return value \todo desc Add sth to the todo list \deprecated desc \warning desc \attention desc \remarks desc