RT-Thread RTOS
An open source embedded real-time operating system
Loading...
Searching...
No Matches
How to write doxygen documentation for structure.

We recommend the following approach:

A comment block before the structure definition is recommended to describe the general information of the structure type. In the comment block, a @brief is required, other commands (such as @note) are optional.

If you feel that the description of @brief is not enough, you can add a detailed description part, which is also optional.

Put member comments inside the structure definition and after every member.

See documentation/0.doxygen/example/include/struct.h for example.