Espressif ESP32-S2 Programming Manual page 1589

Chapter 6. Contributions Guide
2. Documentation of function should describe what this function does. If it accepts input parameters and returns
some value, all of them should be explained.
3. Do not add a data type before parameter or any other characters besides spaces. All spaces and line breaks are
compressed into a single space. If you like to break a line, then break it twice.
4. If function has void input or does not return any value, then skip @param or @return
5. When documenting a define as well as members of a struct or enum, place specific comment like below
after each member.
6. To provide well formatted lists, break the line after command (like @return in example below).
Espressif Systems 1578
Submit Document Feedback
Release v4.4