diff --git a/documentation/0.doxygen/example/include/enum.h b/documentation/0.doxygen/example/include/enum.h index 14fda47b086..a4a9cd53528 100644 --- a/documentation/0.doxygen/example/include/enum.h +++ b/documentation/0.doxygen/example/include/enum.h @@ -14,15 +14,23 @@ * * See * documentation/0.doxygen/example/include/enum.h - * for example. + * for code example. + * + * See + * Doxygen Example of Enumeration + * for html output. */ /** - * @addtogroup group_doxygen_example + * @defgroup group_doxygen_example_enum Doxygen Example of Enumeration + * + * @ingroup group_doxygen_example + * + * @brief Doxygen Example of Enumeration. + * + * @{ */ -/** @{ */ - /** * @brief Brief description of this enumeration */ diff --git a/documentation/0.doxygen/example/include/groups.h b/documentation/0.doxygen/example/include/groups.h index 04b14d43fcc..71ea20d83cc 100644 --- a/documentation/0.doxygen/example/include/groups.h +++ b/documentation/0.doxygen/example/include/groups.h @@ -24,14 +24,18 @@ * * See * documentation/0.doxygen/example/include/groups.h - * for example. + * for code example. + * + * See + * Doxygen Example of Groups and Sub-Groups + * for html output. * * More information can be found in the Doxygen manual: * Grouping. */ /** - * @defgroup group_doxygen_example_sub Sub Group of Doxygen Example + * @defgroup group_doxygen_example_sub Doxygen Example of Groups * * All members of this group will be displayed in one HTML page. * diff --git a/documentation/0.doxygen/example/include/macro.h b/documentation/0.doxygen/example/include/macro.h index a5c1d7f352d..b849909eb54 100644 --- a/documentation/0.doxygen/example/include/macro.h +++ b/documentation/0.doxygen/example/include/macro.h @@ -10,7 +10,7 @@ * recommend putting documentation after members. See `DOXYGEN_EXAMPLE_CONST_A` * and `DOXYGEN_EXAMPLE_CONST_B` in * documentation/0.doxygen/example/include/macro.h - * for exmaple. + * for code exmaple. * * - The other is to define macros with parameters. For this type of * macro, we recommend using a method similar to documenting for @@ -18,15 +18,23 @@ * More details please see @ref page_howto_function * See `DOXYGEN_EXAMPLE_ABS` in * documentation/0.doxygen/example/include/macro.h - * for example. + * for code example. + * + * See + * Doxygen Example of Macro + * for html output. */ -/** - * @addtogroup group_doxygen_example + /** + * @defgroup group_doxygen_example_macro Doxygen Example of Macro + * + * @ingroup group_doxygen_example + * + * @brief Doxygen Example of Macro. + * + * @{ */ -/** @{ */ - #define DOXYGEN_EXAMPLE_CONST_A 100 /**< Description of macro const A */ #define DOXYGEN_EXAMPLE_CONST_B 200 /**< Description of macro const B */ diff --git a/documentation/0.doxygen/example/include/struct.h b/documentation/0.doxygen/example/include/struct.h index 528e85487ab..46f130319d9 100644 --- a/documentation/0.doxygen/example/include/struct.h +++ b/documentation/0.doxygen/example/include/struct.h @@ -18,15 +18,23 @@ * * See * documentation/0.doxygen/example/include/struct.h - * for example. + * for code example. + * + * See + * Doxygen Example of Structure + * for html output. */ /** - * @addtogroup group_doxygen_example + * @defgroup group_doxygen_example_struct Doxygen Example of Structure + * + * @ingroup group_doxygen_example + * + * @brief Doxygen Example of Structure. + * + * @{ */ -/** @{ */ - /** * @brief Brief description this structure * diff --git a/documentation/0.doxygen/example/include/typedef.h b/documentation/0.doxygen/example/include/typedef.h index eeb004fb5b9..2232f31bc69 100644 --- a/documentation/0.doxygen/example/include/typedef.h +++ b/documentation/0.doxygen/example/include/typedef.h @@ -26,18 +26,26 @@ * * See * documentation/0.doxygen/example/include/typedef.h - * for example. + * for code example. + * + * See + * Doxygen Example of Typedef + * for html output. */ #include "struct.h" #include "enum.h" /** - * @addtogroup group_doxygen_example + * @defgroup group_doxygen_example_typedef Doxygen Example of Typedef + * + * @ingroup group_doxygen_example + * + * @brief Doxygen Example of Typedef. + * + * @{ */ -/** @{ */ - /** * @typedef dogygen_example_struct_t * Alias of `struct dogygen_example_struct`. @@ -49,7 +57,7 @@ typedef struct dogygen_example_struct dogygen_example_struct_t; typedef struct dogygen_example_struct_another dogygen_example_struct_another_t; /** - * @typedef doxygen_example_enum + * @typedef doxygen_example_enum_t * Alias of `enum doxygen_example_enum`. */ typedef enum doxygen_example_enum doxygen_example_enum_t; diff --git a/documentation/0.doxygen/example/include/union.h b/documentation/0.doxygen/example/include/union.h index 1af9f13ef2b..9dbf2e47445 100644 --- a/documentation/0.doxygen/example/include/union.h +++ b/documentation/0.doxygen/example/include/union.h @@ -14,15 +14,23 @@ * * See * documentation/0.doxygen/example/include/union.h - * for example. + * for code example. + * + * See + * Doxygen Example of Union + * for html output. */ /** - * @addtogroup group_doxygen_example + * @defgroup group_doxygen_example_union Doxygen Example of Union + * + * @ingroup group_doxygen_example + * + * @brief Doxygen Example of Union. + * + * @{ */ -/** @{ */ - /** * @brief Brief description of this union */ diff --git a/documentation/0.doxygen/example/src/function.c b/documentation/0.doxygen/example/src/function.c index 6ac5dc90de1..289c09b2ce8 100644 --- a/documentation/0.doxygen/example/src/function.c +++ b/documentation/0.doxygen/example/src/function.c @@ -43,17 +43,27 @@ * * See * documentation/0.doxygen/example/src/function.c - * for example. + * for code example. * - * documentation/0.doxygen/example/src/function.h is an example of the header file where we just declare the API without doxygen documentation. + * See + * Doxygen Example of Function + * for html output. + * + * @note documentation/0.doxygen/example/src/function.h + * 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 *