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