Api Documentation Template - Espressif ESP32-S2 Programming Manual

Chapter 6. Contributions Guide
• The example should have a README.md file. Use the
particular example.
• Examples should have an example_test.py file for running an automated example test. If submitting a
GitHub Pull Request which includes an example, it's OK not to include this file initially. The details can be
discussed as part of the
General Guidelines
Example code should follow the
Checklist
Checklist before submitting a new example:
• Example project name (in Makefile and README.md) uses the word"example" . Use"example" instead
of "demo", "test"or similar words.
• Example does one distinct thing. If the example does more than one thing at a time, split it into two or more
examples.
• Example has a README.md file which is similar to the
• Functions and variables in the example are named according to
names which are only specific to the example's source files, you can use example or something similar as
a prefix.)
• All code in the example is well structured and commented.
• Any unnecessary code (old debugging logs, commented-out code, etc.) is removed from the example.
• Options in the example (like network names, addresses, etc) are not hard-coded. Use configuration items if
possible, or otherwise declare macros or constants)
• Configuration items are provided in a KConfig.projbuild file with a menu named "Example Configu-
ration". See existing example projects to see how this is done.
• All original example code has a license header saying it is "in the public domain / CC0", and a warranty
disclaimer clause. Alternatively, the example is licensed under Apache License 2.0. See existing examples for
headers to adapt from.
• Any adapted or third party example code has the original license header on it. This code must be licensed
compatible with Apache License 2.0.

6.5.5 API Documentation Template

Note: INSTRUCTIONS
1. Use this file (docs/en/api-reference/template.rst) as a template to document API.
2. Change the file name to the name of the header file that represents documented API.
3. Include respective files with descriptions from the API folder using ..include::
• README.rst
• example.rst
• ...
4. Optionally provide description right in this file.
5. Once done, remove all instructions like this one and any superfluous headers.
Overview
Note: INSTRUCTIONS
1. Provide overview where and how this API may be used.
2. Where applicable include code snippets to illustrate functionality of particular functions.
Espressif Systems
Pull Request.
Espressif IoT Development Framework Style
1582
Submit Document Feedback
template example README
Guide.
template example README
naming section of the style
and adapt it for your
.
guide. (For non-static
Release v4.4