iLLD_TC27xD  1.0
lld_conventionsDoxygen.c
Go to the documentation of this file.
1 /**
2  \page lld_doxygenRules Doxygen rules
3 
4  \section ucRootGroup Microcontroller root group
5  The microcontroller documentation root group is IfxLld. The group is defined in the file info.dox located in the microcontroller derivative root directory.
6 
7  Example:
8  \code
9  * \defgroup IfxLld TC27x B-Step Microcontroller
10  \endcode
11 
12  \section moduleGroup Modules group
13  Module's group names have the follwing syntax: '\\defgroup IfxLld_<Module>'.
14  The group is direct child of the \ref ucRootGroup.
15 
16 v <Module> is the module short name in with the 1st letter upper case and then lower case. The group name is defined in the Ifx<Module>_regdef.h file. Example:
17  \code
18  * \defgroup IfxLld_Dma DMA
19  * \ingroup IfxLld
20  \endcode
21 
22  The following groups are also defined in the Ifx<Module>_regdef.h file for each modules:
23  - IfxLld_<Module>_Bitfields : Bitfield macro definition
24  - IfxLld_<Module>_Union : module union types
25  - IfxLld_<Module>_Struct : module struct types
26 
27  \section moduleStdGroup Module standard driver group
28  Module's standard driver group have the follwing syntax: '\\defgroup IfxLld_<Module>_Std'.
29  The group is direct child of the \ref moduleGroup.
30 
31  Example:
32  \code
33  * \defgroup IfxLld_Asclin_Std Basic functionality
34  * \ingroup IfxLld_Asclin
35  \endcode
36 
37 
38  \section moduleInterfaceGroup Module interface driver group
39  Module's interface driver group have the follwing syntax: '\\defgroup IfxLld_<Module>_<Interface>'.
40  The group is direct child of the \ref moduleGroup.
41 
42  <Interface> is the interface driver name.
43 
44  Example:
45  \code
46  * \defgroup IfxLld_Asclin_AscIf ASC interface driver
47  * Implements the standard ASC interface
48  * \ingroup IfxLld_Asclin
49  \endcode
50 
51  \section generalRules General rules
52  - As group name are global names, a group name shall start with the parent group name.
53  - Group names are 1st letter upper case, then camel case, group levels are separated by underscore
54 
55  Example:
56  - |--IfxLld
57  - | |--IfxLld_Dma
58  - | | |--IfxLld_Dma_Std
59  - | | |--IfxLld_Dma_Std_ChannelTransaction
60  - | | |--IfxLld_Dma_Dma
61 
62 
63  \section docReturnValue Documentation of return values
64  The return value shall be documented using \\return when docuementation is provided for a single case.
65 
66  The return value shall be documented using \\retval when docuementation is provided for a multiple case.
67 
68  Example (single case):
69  \code
70  * \return Return the raw converted analog value.
71  \endcode
72  Output:
73  * \return Return the raw converted analog value.
74 
75  Example (multiple case):
76  \code
77  * \retval TRUE in case of success
78  * \retval FALSE in case of error
79  \endcode
80  Output:
81  * \retval TRUE in case of success
82  * \retval FALSE in case of error
83 
84 
85  \section parameterDocumentation
86  Documentation shall provide range for parameters when not entirely defined.
87 
88  Example:
89  \code
90  // \param transferCount Number of transaction, Range=[0,32]
91  IFX_INLINE void IfxDma_setChannelTransaction(Ifx_DMA* dma,IfxDma_ChannelId channelId, uint32 transferCount)
92  { ... }
93  \endcode
94 
95 [\ref lld_dosanddont_if "Previous page"] [\ref lld_filesAndConfig "Next page"]
96 
97 */