mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-10-19 12:14:30 +08:00
doxygen: improve howto
- Add description on how to group macros. - Add description for structs on how to write comments for members when the name of member is too. - Use @ref to link group instead of the html filenames. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
This commit is contained in:
@@ -15,14 +15,24 @@
|
||||
* can add a detailed description part, which is also optional.
|
||||
*
|
||||
* Put member comments inside the structure definition and after every member.
|
||||
* See `struct dogygen_example_struct` for example.
|
||||
*
|
||||
* If the structure member is too long (this often happens when the structure
|
||||
* member is a callback function), when the comment is written after the member,
|
||||
* it will make the code line too long. In this case, we can also put the comment
|
||||
* before the member. See `struct dogygen_example_struct_another` for example.
|
||||
*
|
||||
* Going a step further, for this kind of structure whose members are callback
|
||||
* functions, we can describe the members in style for functions, it is more
|
||||
* complicated and contains more content. It is useful when we want to describe
|
||||
* the parameters and return values of the callback function in more detail.
|
||||
* See `struct dogygen_example_struct_another2` for example.
|
||||
*
|
||||
* See
|
||||
* <a href="https://github.com/RT-Thread/rt-thread/blob/master/documentation/0.doxygen/example/include/struct.h">documentation/0.doxygen/example/include/struct.h</a>
|
||||
* for code example.
|
||||
*
|
||||
* See
|
||||
* <a href="./group__group__doxygen__example__struct.html">Doxygen Example of Structure</a>
|
||||
* for html output.
|
||||
* See @ref group_doxygen_example_struct for html output.
|
||||
*/
|
||||
|
||||
/**
|
||||
@@ -68,17 +78,40 @@ struct dogygen_example_struct
|
||||
*/
|
||||
struct dogygen_example_struct_another
|
||||
{
|
||||
int m1; /**< Some documentation for member 'm1'...
|
||||
* Multiple lines ... Note the "multi-line" here refers
|
||||
* to the code. Whether it is displayed in multiple lines
|
||||
* on the specific HTML page depends on the browser rendering.
|
||||
*
|
||||
* @note We can also embed note for member 'm1'...
|
||||
*/
|
||||
int m2; /**< Some documentation for member 'm2'... */
|
||||
int m3; /**< Some documentation for member 'm3'... */
|
||||
int m4; /**< Some documentation for member 'm4'... */
|
||||
int m5; /**< Some documentation for member 'm5'... */
|
||||
/** Some documentation for member 'm1'... */
|
||||
int (*m1)(int *param1, int param2, int param3, int param4);
|
||||
/** Some documentation for member 'm2'... */
|
||||
int (*m2)(int *param1, int param2, int param3, int param4);
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Brief description this structure
|
||||
*
|
||||
* Detailed description starts here, one line or multiple lines.
|
||||
* Blah blah blah...
|
||||
*
|
||||
* @note This is a note for this structure, blah blah blah...
|
||||
*/
|
||||
struct dogygen_example_struct_another2
|
||||
{
|
||||
/**
|
||||
* @brief Brief description of m1
|
||||
* @param param1 The first param.
|
||||
* @param param2 The second param.
|
||||
* @param param3 The third param.
|
||||
* @param param4 The fourth param.
|
||||
* @return the operation status, 0 on successful
|
||||
*/
|
||||
int (*m1)(int *param1, int param2, int param3, int param4);
|
||||
/**
|
||||
* @brief Brief description of m2
|
||||
* @param param1 The first param.
|
||||
* @param param2 The second param.
|
||||
* @param param3 The third param.
|
||||
* @param param4 The fourth param.
|
||||
* @return the operation status, 0 on successful
|
||||
*/
|
||||
int (*m2)(int *param1, int param2, int param3, int param4);
|
||||
};
|
||||
|
||||
/** @} */
|
||||
|
Reference in New Issue
Block a user