doc: fix warnings in groups.rst

Add missing '*/', rename <entity> 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 <inaky.perez-gonzalez@intel.com>
This commit is contained in:
Inaky Perez-Gonzalez 2016-06-13 15:09:44 -07:00 committed by Anas Nashif
commit 71228b4ad1

View file

@ -25,18 +25,18 @@ The desired entities must be inside the comment block that uses the syntax :lite
.. code-block:: C
/** @defgroup <GroupLabel> Group Name
* Detailed Description of the Group
* @{
*/
/** @defgroup <GroupLabel> Group Name
* Detailed Description of the Group
* @{
*/
/* @brief Brief description of the entity*/
<entity1>
/* @brief Brief description of the entity*/
ENTITY1;
/* @brief Brief description of the entity*/
<entity2>
/* @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 <GroupLabel>`.
@ -46,11 +46,12 @@ Example:
.. code-block:: C
/** @addtogroup <GroupLabel>
* Optional: This line adds information to the GroupLabel Detailed Description of the Group
* @{
*/
/** @addtogroup <GroupLabel>
* 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