![]() |
DC2100A
0.1
Bi-Directional Cell Balancer Using the LTC3300-1 and the LTC6804-2
|
Linduino documentation is automatically generated from the source code using Doxygen. Refer to the following templates when documenting code.
DoxygenExample.ino:
DoxygenExample.h:
DoxygenExample.cpp:
Store the .ino file in a folder with the same name (i.e. "DoxygenDemo.ino" is stored in a folder named "DoxygenDemo"). The folder may be stored in LTSketchbook or in any folder not labeled as Libraries.
If the .h and .cpp files will only be used by one .ino program, store them in the same folder with the .ino file. For example, "DoxygenExample.cpp" and "DoxygenExample.h" are stored in the "DoxygenDemo" folder. Alternatively, if the files form a library to be used by other .ino files, store the "DoxygenExample.h" and "DoxygenExample.cpp" files in the Libararies folder of the LTSketchbook.
The .ino file must include the following lines, where "groupname" is replaced by a descriptive name used to group the .ino, .cpp, and .h files.
/*! @file @ingroup groupname */
Documenting a function with parameters and no return:
//! Message that describes the function //! @return void void function1(int param1, //!< Message that describes the function of the variable float param2, //!< Message that describes the function of the variable char param3 //!< Message that describes the function of the variable ) { }
Click here to see the output.
Documenting a function with no parameters and a return:
//! Message that describes the function //! @return Describe the return conditions float function2() { }
Click here to see the output.
The header file (*.h) must include the following lines, where "groupname" is replaced by a descriptive name used to group the .ino, .cpp, and .h files.
/*! @file @ingroup groupname Header for Description_of_the_header */
The C++ file (*.cpp) must include the following lines, where "groupname" is replaced by a descriptive name used to group the .ino, .cpp, and .h files.
//! @defgroup groupname Doxygen Documentation Example /*! @file @ingroup groupname Library for Description_of_the_header */
It is recommended that the Doxygen documentation for functions be placed in the header file (*.h) and not the C++ file (*.cpp).
Documenting a function with no parameters and no return:
//! Message that describes the main function //! @return void void function3();
Click here to see the output.
Documenting a function with parameters and a return:
//! Message that describes the main function //! @return Describe the return conditions int function4(int var1, //!< Message that describes the function of the variable float var2 //!< Message that describes the function of the variable );
Click here to see the output.
Note: If the comment that describes the variable is placed after the semicolon, Doxygen will not document the last variable. Be sure to comment the variables before the semicolon.
static float float_var; //!< Message that describes the function of the variable const int int_var; //!< Message that describes the function of the constant variable #define var //!< Message that describes the function of the define //! Enum Description enum EnumType { int EVal1, /**< enum value 1 */ int EVal2 /**< enum value 2 */ };
/*! @name TITLE @{ The section that receives the title. @} */
First Header | Second Header ------------- | ------------- Content Cell | Content Cell Content Cell | Content Cell
First Header | Second Header |
---|---|
Content Cell | Content Cell |
Content Cell | Content Cell |
Column alignment can be controlled via one or two colons at the header separator line:
| Right | Center | Left | | ----: | :----: | :---- | | 10 | 10 | 10 | | 1000 | 1000 | 1000 |
Right | Center | Left |
---|---|---|
10 | 10 | 10 |
1000 | 1000 | 1000 |
- Item 1 More text for this item. - Item 2 + nested list item. + another nested item. - Item 3
Item 1
More text for this item.
[The link text](http://www.linear.com/ "Link title")

_single underscores_
single underscores
\b word <b> more than one word </b>
word
more than one word
Add the following comment above the function with the bug
//! @bug bug description
For more information please refer to the Doxygen manual in the Doxygen website