From 71228b4ad13609bcabcd679d36152b6cc9885d12 Mon Sep 17 00:00:00 2001 From: Inaky Perez-Gonzalez Date: Mon, 13 Jun 2016 15:09:44 -0700 Subject: [PATCH] doc: fix warnings in groups.rst Add missing '*/', rename to ENTITY and fix indentation so the formatting engine recognizes the example code as C code. Change-Id: Iff1b5c0cef5bb635ba1b39f507ff657e9ab4c338 Signed-off-by: Inaky Perez-Gonzalez --- doc/contribute/doxygen/groups.rst | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/doc/contribute/doxygen/groups.rst b/doc/contribute/doxygen/groups.rst index 3d3575b91b1..aafee3c4bce 100644 --- a/doc/contribute/doxygen/groups.rst +++ b/doc/contribute/doxygen/groups.rst @@ -25,18 +25,18 @@ The desired entities must be inside the comment block that uses the syntax :lite .. code-block:: C - /** @defgroup Group Name - * Detailed Description of the Group - * @{ - */ + /** @defgroup Group Name + * Detailed Description of the Group + * @{ + */ - /* @brief Brief description of the entity*/ - + /* @brief Brief description of the entity*/ + ENTITY1; - /* @brief Brief description of the entity*/ - + /* @brief Brief description of the entity*/ + ENTITY2; - /** @} */ // End of GroupLabel + /** @} */ // End of GroupLabel If you need to add more information that is not listed inside the group block, you must use :literal:`@addtogroup `. @@ -46,11 +46,12 @@ Example: .. code-block:: C - /** @addtogroup - * Optional: This line adds information to the GroupLabel Detailed Description of the Group - * @{ - */ + /** @addtogroup + * Optional: This line adds information to the GroupLabel Detailed Description of the Group + * @{ + */ - /* The entities you want to add must be inserted inside before the close block*/ + /* The entities you want to add must be inserted inside before the close block*/ + + /** @} // End of addtogroup GroupLabel */ - /** @} // End of addtogroup GroupLabel \ No newline at end of file