4 Linduino documentation is automatically generated from the source code
using
5 Doxygen. Refer to the following templates when documenting code.
7 \b %DoxygenExample.ino:
9 [Source Code](file:./DoxygenExample_8cpp_source.html
"Source Code")
11 [Doxygen Generated Output](file:./DoxygenExample_8cpp.html
"Doxygen Generated Output")
15 [Source Code](file:./DoxygenExample_8h_source.html
"Source Code")
17 [Doxygen Generated Output](file:./DoxygenExample_8h.html
"Doxygen Generated Output")
19 \b %DoxygenExample.cpp:
21 [Source Code](file:./DoxygenExample_8cpp_source.html
"Source Code")
23 [Doxygen Generated Output](file:./DoxygenExample_8cpp.html
"Doxygen Generated Output")
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.
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.
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>
47 Documenting a
function with parameters and no
return:
53 void function1(
int param1,
61 Click \ref function1()
"here" to see the output.
63 Documenting a
function with no parameters and a
return:
73 Click \ref function2()
"here" to see the output.
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>
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>
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>
107 Documenting a function with no parameters and no return:
116 Click \ref function3() "here" to see the output.
118 Documenting a function with parameters and a return:
124 int function4(
int var1,
129 Click \ref function3() "here" to see the output.
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>
134 Documenting Global Variables, Constants, Defines, and Enum
135 ----------------------------------------------------
138 static
float float_var;
164 First Header | Second Header
165 ------------- | -------------
166 Content Cell | Content Cell
167 Content Cell | Content Cell
170 First Header | Second Header
171 ------------- | -------------
172 Content Cell | Content Cell
173 Content Cell | Content Cell
175 Column alignment can be controlled via one or two colons at the header separator line:
178 | Right | Center | Left |
179 | ----: | :----: | :---- |
181 | 1000 | 1000 | 1000 |
185 | Right | Center | Left |
186 | ----: | :----: | :---- |
188 | 1000 | 1000 | 1000 |
195 More text
for this item.
199 + another nested item.
205 More text
for this item.
209 + another nested item.
215 [The link text](http:
217 [The link text](http:
222 
238 <b> more than one word </b>
243 <b> more than one word </b>
245 Adding a bug to the bug list
246 --------------------------------
247 Add the following comment above the
function with the bug
256 For more information please refer to the Doxygen manual in the [Doxygen website](http: