Chapter 6. Contributions Guide
/**
* @param ratio this is oxygen to air ratio
*/
Doxygen is phrasing the code, extracting the commands together with subsequent text, and building documentation
out of it.
Typical comment block, that contains documentation of a function, looks like below.
Doxygen supports couple of formatting styles. It also gives you great flexibility on level of details to include in
documentation. To get familiar with available features, please check data rich and very well organized Doxygen
Manual.
Why we need it?
The ultimate goal is to ensure that all the code is consistently documented, so we can use tools like Sphinx and Breathe
to aid preparation and automatic updates of API documentation when the code changes.
With these tools the above piece of code renders like below:
Go for it!
When writing code for this repository, please follow guidelines below.
1. Document all building blocks of code: functions, structs, typedefs, enums, macros, etc. Provide enough in-
formation about purpose, functionality and limitations of documented items, as you would like to see them
documented when reading the code by others.
Espressif Systems 1577
Submit Document Feedback
Release v4.4
To Next Page
Loading...
Need help?
General