DC2100A  0.1
Bi-Directional Cell Balancer Using the LTC3300-1 and the LTC6804-2
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
DoxygenReference.md
1 Doxygen Reference
2 ==================
3 
4 Linduino documentation is automatically generated from the source code using
5 Doxygen. Refer to the following templates when documenting code.
6 
7 \b %DoxygenExample.ino:
8 
9 [Source Code](file:./DoxygenExample_8cpp_source.html "Source Code")
10 
11 [Doxygen Generated Output](file:./DoxygenExample_8cpp.html "Doxygen Generated Output")
12 
13 \b %DoxygenExample.h:
14 
15 [Source Code](file:./DoxygenExample_8h_source.html "Source Code")
16 
17 [Doxygen Generated Output](file:./DoxygenExample_8h.html "Doxygen Generated Output")
18 
19 \b %DoxygenExample.cpp:
20 
21 [Source Code](file:./DoxygenExample_8cpp_source.html "Source Code")
22 
23 [Doxygen Generated Output](file:./DoxygenExample_8cpp.html "Doxygen Generated Output")
24 
25 Store the .ino file in a folder with the same name (i.e. "DoxygenDemo.ino" is
26 stored in a folder named "DoxygenDemo"). The folder may be stored in
27 LTSketchbook or in any folder not labeled as Libraries.
28 
29 If the .h and .cpp files will only be used by one .ino program, store them in the
30 same folder with the .ino file. For example, "DoxygenExample.cpp" and
31 "DoxygenExample.h" are stored in the "DoxygenDemo" folder. Alternatively, if the
32 files form a library to be used by other .ino files, store the "DoxygenExample.h"
33 and "DoxygenExample.cpp" files in the Libararies folder of the LTSketchbook.
34 
35 Documenting the .ino
36 --------------------
37 <b>The .ino file must include the following lines, where "groupname" is replaced by a
38 descriptive name used to group the .ino, .cpp, and .h files.</b>
39 
40 @verbatim
41 
42 /*! @file
43  @ingroup groupname
44 */
45 @endverbatim
46 
47 Documenting a function with parameters and no return:
48 
49 @verbatim
50 
51 //! Message that describes the function
52 //! @return void
53 void function1(int param1, //!< Message that describes the function of the variable
54  float param2, //!< Message that describes the function of the variable
55  char param3 //!< Message that describes the function of the variable
56  )
57 {
58 }
59 
60 @endverbatim
61 Click \ref function1() "here" to see the output.
62 
63 Documenting a function with no parameters and a return:
64 
65 @verbatim
66 
67 //! Message that describes the function
68 //! @return Describe the return conditions
69 float function2()
70 {
71 }
72 @endverbatim
73 Click \ref function2() "here" to see the output.
74 
75 
76 Documenting for the C++ and Header File
77 ------------------------------------------
78 <b>The header file (*.h) must include the following lines, where "groupname" is
79 replaced by a descriptive name used to group the .ino, .cpp, and .h files.</b>
80 
81 @verbatim
82 
83 /*! @file
84  @ingroup groupname
85  Header for Description_of_the_header
86 */
87 
88 @endverbatim
89 
90 <b>The C++ file (*.cpp) must include the following lines, where "groupname" is replaced by a
91 descriptive name used to group the .ino, .cpp, and .h files.</b>
92 
93 @verbatim
94 
95 //! @defgroup groupname Doxygen Documentation Example
96 
97 /*! @file
98  @ingroup groupname
99  Library for Description_of_the_header
100 */
101 
102 @endverbatim
103 
104 <b>It is recommended that the Doxygen documentation for functions be placed in the
105 header file (*.h) and not the C++ file (*.cpp).</b>
106 
107 Documenting a function with no parameters and no return:
108 
109 @verbatim
110 
111 //! Message that describes the main function
112 //! @return void
113 void function3();
114 
115 @endverbatim
116 Click \ref function3() "here" to see the output.
117 
118 Documenting a function with parameters and a return:
119 
120 @verbatim
121 
122 //! Message that describes the main function
123 //! @return Describe the return conditions
124 int function4(int var1, //!< Message that describes the function of the variable
125  float var2 //!< Message that describes the function of the variable
126  );
127 
128 @endverbatim
129 Click \ref function3() "here" to see the output.
130 
131 <b> Note: If the comment that describes the variable is placed after the semicolon, Doxygen
132 will not document the last variable. Be sure to comment the variables before the semicolon.</b>
133 
134 Documenting Global Variables, Constants, Defines, and Enum
135 ----------------------------------------------------
136 
137 @verbatim
138 static float float_var; //!< Message that describes the function of the variable
139 const int int_var; //!< Message that describes the function of the constant variable
140 #define var //!< Message that describes the function of the define
141 
142 //! Enum Description
143 enum EnumType
144  {
145  int EVal1, /**< enum value 1 */
146  int EVal2 /**< enum value 2 */
147  };
148 @endverbatim
149 
150 Adding a Title
151 ---------------
152 @verbatim
153 /*! @name TITLE
154 @{
155  The section that receives the title.
156 @}
157 */
158 @endverbatim
159 
160 Making Tables
161 -------------
162 
163 @verbatim
164 First Header | Second Header
165 ------------- | -------------
166 Content Cell | Content Cell
167 Content Cell | Content Cell
168 @endverbatim
169 
170 First Header | Second Header
171 ------------- | -------------
172 Content Cell | Content Cell
173 Content Cell | Content Cell
174 
175 Column alignment can be controlled via one or two colons at the header separator line:
176 
177 @verbatim
178 | Right | Center | Left |
179 | ----: | :----: | :---- |
180 | 10 | 10 | 10 |
181 | 1000 | 1000 | 1000 |
182 @endverbatim
183 
184 
185 | Right | Center | Left |
186 | ----: | :----: | :---- |
187 | 10 | 10 | 10 |
188 | 1000 | 1000 | 1000 |
189 
190 Making Lists
191 ------------
192 @verbatim
193 - Item 1
194 
195  More text for this item.
196 
197 - Item 2
198  + nested list item.
199  + another nested item.
200 - Item 3
201 @endverbatim
202 
203 - Item 1
204 
205  More text for this item.
206 
207 - Item 2
208  + nested list item.
209  + another nested item.
210 - Item 3
211 
212 Links
213 ------
214 @verbatim
215 [The link text](http://www.linear.com/ "Link title")
216 @endverbatim
217 [The link text](http://www.linear.com/ "Link title")
218 
219 Images
220 -------
221 @verbatim
222 ![Caption text](/path/to/img.jpg "Image title")
223 @endverbatim
224 
225 Emphasis
226 ---------
227 @verbatim
228 _single underscores_
229 @endverbatim
230 _single underscores_
231 
232 Bold
233 -----
234 @verbatim
235 
236 \b word
237 
238 <b> more than one word </b>
239 
240 @endverbatim
241 \b word
242 
243 <b> more than one word </b>
244 
245 Adding a bug to the bug list
246 --------------------------------
247 Add the following comment above the function with the bug
248 @verbatim
249 
250 //! @bug bug description
251 
252 @endverbatim
253 
254 More Information
255 ----------------
256 For more information please refer to the Doxygen manual in the [Doxygen website](http://www.doxygen.org/ "Doxygen")