diff options
Diffstat (limited to 'documentation/0.doxygen/example/src/function.c')
| -rw-r--r-- | documentation/0.doxygen/example/src/function.c | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/documentation/0.doxygen/example/src/function.c b/documentation/0.doxygen/example/src/function.c index 6ac5dc90de..289c09b2ce 100644 --- a/documentation/0.doxygen/example/src/function.c +++ b/documentation/0.doxygen/example/src/function.c @@ -43,17 +43,27 @@ * * See * <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 example. + * for code example. * - * <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 an example of the header file where we just declare the API without doxygen documentation. + * See + * <a href="./group__group__doxygen__example__function.html">Doxygen Example of Function</a> + * 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 + * doxygen documentation. */ /** - * @addtogroup group_doxygen_example + * @defgroup group_doxygen_example_function Doxygen Example of Function + * + * @ingroup group_doxygen_example + * + * @brief Doxygen Example of Function. + * + * @{ */ -/** @{ */ - /** * @brief Brief description for the function * |