5 Linduino documentation is automatically generated from the source code using
6 Doxygen. Refer to the following templates when documenting code.
8 \b %DoxygenExample.ino:
10 [Source Code](file:./DoxygenExample_8cpp_source.html "Source Code")
12 [Doxygen Generated Output](file:./DoxygenExample_8cpp.html "Doxygen Generated Output")
16 [Source Code](file:./DoxygenExample_8h_source.html "Source Code")
18 [Doxygen Generated Output](file:./DoxygenExample_8h.html "Doxygen Generated Output")
20 \b %DoxygenExample.cpp:
22 [Source Code](file:./DoxygenExample_8cpp_source.html "Source Code")
24 [Doxygen Generated Output](file:./DoxygenExample_8cpp.html "Doxygen Generated Output")
26 Store the .ino file in a folder with the same name (i.e. "DoxygenDemo.ino" is
27 stored in a folder named "DoxygenDemo"). The folder may be stored in
28 LTSketchbook or in any folder not labeled as Libraries.
30 If the .h and .cpp files will only be used by one .ino program, store them in the
31 same folder with the .ino file. For example, "DoxygenExample.cpp" and
32 "DoxygenExample.h" are stored in the "DoxygenDemo" folder. Alternatively, if the
33 files form a library to be used by other .ino files, store the "DoxygenExample.h"
34 and "DoxygenExample.cpp" files in the Libararies folder of the LTSketchbook.
38 <b>The .ino file must include the following lines, where "groupname" is replaced by a
39 descriptive name used to group the .ino, .cpp, and .h files.</b>
48 Documenting a function with parameters and no return:
52 //! Message that describes the function
54 void function1(int param1, //!< Message that describes the function of the variable
55 float param2, //!< Message that describes the function of the variable
56 char param3 //!< Message that describes the function of the variable
62 Click \ref function1() "here" to see the output.
64 Documenting a function with no parameters and a return:
68 //! Message that describes the function
69 //! @return Describe the return conditions
74 Click \ref function2() "here" to see the output.
77 Documenting for the C++ and Header File
78 ------------------------------------------
79 <b>The header file (*.h) must include the following lines, where "groupname" is
80 replaced by a descriptive name used to group the .ino, .cpp, and .h files.</b>
86 Header for Description_of_the_header
91 <b>The C++ file (*.cpp) must include the following lines, where "groupname" is replaced by a
92 descriptive name used to group the .ino, .cpp, and .h files. "categoryname" is replaced by one
93 of the categories shown the table below. </b>
100 @defgroup groupname Doxygen Documentation Example
103 Library for Description_of_the_header
108 categoryname | Description
109 ---------------------------- | -------------------------------------------------------------------------------------
110 Linduino | Linduino: Linear Technology Arduino-Compatible Demonstration Board Support Libraries
111 Analog_to_Digital_Converters | Analog-to-Digital Converters (ADC)
112 Digital_to_Analog_Converters | Digital-to-Analog Converters (DAC)
114 Power_Monitors | Power Monitors and Coulomb Counters
115 Power_System_Management | Digital Power System Management and Power Supply Supervisors
116 Switching_Regulators | Switching Regulators, Battery Chargers, and LED Drivers
117 Transceivers | Transceivers
118 Temperature_Monitors | Temperature Monitors
119 RF_Timing | RF, Silicon Oscillators, PLL Synthesizers, and VCOs
120 BMS | Battery Management System (BMS)
121 PMBus_SMBus | PMBus and SMBus Support Libraries
122 Example_Designs | Example Designs
123 User_Contributed | User Contributed Libraries (Not Supported by Linear Technology)
124 Third_Party | Third-Party Libraries (Not Supported by Linear Technology)
125 Documentation | Documentation
126 WIP | Work in Progress
128 <b>It is recommended that the Doxygen documentation for functions be placed in the
129 header file (*.h) and not the C++ file (*.cpp).</b>
131 Documenting a function with no parameters and no return:
135 //! Message that describes the main function
140 Click \ref function3() "here" to see the output.
142 Documenting a function with parameters and a return:
146 //! Message that describes the main function
147 //! @return Describe the return conditions
148 int function4(int var1, //!< Message that describes the function of the variable
149 float var2 //!< Message that describes the function of the variable
153 Click \ref function3() "here" to see the output.
155 <b> Note: If the comment that describes the variable is placed after the semicolon, Doxygen
156 will not document the last variable. Be sure to comment the variables before the semicolon.</b>
158 Documenting Global Variables, Constants, Defines, and Enum
159 ----------------------------------------------------
162 static float float_var; //!< Message that describes the function of the variable
163 const int int_var; //!< Message that describes the function of the constant variable
164 #define var //!< Message that describes the function of the define
169 int EVal1, /**< enum value 1 */
170 int EVal2 /**< enum value 2 */
179 The section that receives the title.
188 First Header | Second Header
189 ------------- | -------------
190 Content Cell | Content Cell
191 Content Cell | Content Cell
194 First Header | Second Header
195 ------------- | -------------
196 Content Cell | Content Cell
197 Content Cell | Content Cell
199 Column alignment can be controlled via one or two colons at the header separator line:
202 | Right | Center | Left |
203 | ----: | :----: | :---- |
205 | 1000 | 1000 | 1000 |
209 | Right | Center | Left |
210 | ----: | :----: | :---- |
212 | 1000 | 1000 | 1000 |
219 More text for this item.
223 + another nested item.
229 More text for this item.
233 + another nested item.
239 [The link text](http://www.linear.com/ "Link title")
241 [The link text](http://www.linear.com/ "Link title")
246 
262 <b> more than one word </b>
267 <b> more than one word </b>
269 Adding a bug to the bug list
270 --------------------------------
271 Add the following comment above the function with the bug
274 //! @bug bug description
280 For more information please refer to the Doxygen manual in the [Doxygen website](http://www.doxygen.org/ "Doxygen")
282 @defgroup Linduino Linduino: Linear Technology Arduino-Compatible Demonstration Board Support Libraries
283 @defgroup Analog_to_Digital_Converters Analog-to-Digital Converters (ADC)
284 @defgroup Digital_to_Analog_Converters Digital-to-Analog Converters (DAC)
285 @defgroup Hot_Swap Hot Swap
286 @defgroup Power_Monitors Power Monitors and Coulomb Counters
287 @defgroup Power_System_Management Digital Power System Management and Power Supply Supervisors
288 @defgroup Switching_Regulators Switching Regulators, Battery Chargers, and LED Drivers
289 @defgroup Transceivers Transceivers
290 @defgroup Temperature_Monitors Temperature Monitors
291 @defgroup RF_Timing RF, Silicon Oscillators, PLL Synthesizers, and VCOs
292 @defgroup BMS Battery Management System (BMS)
293 @defgroup PMBus_SMBus PMBus and SMBus Support Libraries
294 @defgroup Example_Designs Example Designs
295 @defgroup User_Contributed User Contributed Libraries (Not Supported by Linear Technology)
296 @defgroup Third_Party Third-Party Libraries (Not Supported by Linear Technology)
297 @defgroup Documentation Documentation
298 @defgroup WIP Work in Progress