diff options
| author | Chen Wang <[email protected]> | 2025-03-06 15:52:37 +0800 |
|---|---|---|
| committer | Rbb666 <[email protected]> | 2025-03-10 10:08:48 +0800 |
| commit | 94afe6a4f17af4669cb843d1ee6f847fbc53c56e (patch) | |
| tree | 6ea85b35165ccb6d546c2b26dd2974fb960ed449 /documentation/0.doxygen/example/src | |
| parent | b5062288934f0e3179556d01b9405353b79a4b99 (diff) | |
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 <[email protected]>
Diffstat (limited to 'documentation/0.doxygen/example/src')
| -rw-r--r-- | documentation/0.doxygen/example/src/function.c | 4 |
1 files changed, 1 insertions, 3 deletions
diff --git a/documentation/0.doxygen/example/src/function.c b/documentation/0.doxygen/example/src/function.c index 289c09b2ce..98b2007dea 100644 --- a/documentation/0.doxygen/example/src/function.c +++ b/documentation/0.doxygen/example/src/function.c @@ -45,9 +45,7 @@ * <a href="https://github.com/RT-Thread/rt-thread/blob/master/documentation/0.doxygen/example/src/function.c">documentation/0.doxygen/example/src/function.c</a> * for code example. * - * See - * <a href="./group__group__doxygen__example__function.html">Doxygen Example of Function</a> - * for html output. + * See @ref group_doxygen_example_function for html output. * * @note <a href="https://github.com/RT-Thread/rt-thread/blob/master/documentation/0.doxygen/example/src/function.h">documentation/0.doxygen/example/src/function.h</a> * is just an example of the header file where we declare the API without |