Chapter 6. Contributions Guide
1. Optionally, rather that using *.inc files, you may want to describe API in you own way. See docs/en/api-
guides/ulp.rst for example.
Below is the list of common .. doxygen...:: directives:
• Functions - .. doxygenfunction:: name_of_function
• Unions -.. doxygenunion:: name_of_union
• Structures -.. doxygenstruct:: name_of_structure together with :members:
• Macros - .. doxygendefine:: name_of_define
• Type Definitions - .. doxygentypedef:: name_of_type
• Enumerations - .. doxygenenum:: name_of_enumeration
See Breathe documentation for additional information.
To provide a link to header file, use the link custom role directive as follows:
* :component_file:`path_to/header_file.h`
1. In any case, to generate API reference, the file docs/doxygen/Doxyfile should be updated with paths to *.h
headers that are being documented.
1. When changes are committed and documentation is build, check how this section has been rendered. Correct
annotations in respective header files, if required.
6.5.6 Contributor Agreement
Individual Contributor Non-Exclusive License Agreement
including the Traditional Patent License OPTION
Thank you for your interest in contributing to Espressif IoT Development Framework (esp-idf) (“We”or “Us”).
The purpose of this contributor agreement (“Agreement”) is to clarify and document the rights granted by con-
tributors to Us. To make this document effective, please follow the instructions at CONTRIBUTING.rst
1. DEFINITIONS “You” means the Individual Copyright owner who submits a Contribution to Us. If You
are an employee and submit the Contribution as part of your employment, You have had Your employer approve this
Agreement or sign the Entity version of this document.
“Contribution”means any original work of authorship (software and/or documentation) including any modifications
or additions to an existing work, Submitted by You to Us, in which You own the Copyright. If You do not own the
Copyright in the entire work of authorship, please contact Us at marius.vikhammer@espressif.com.
“Copyright”means all rights protecting works of authorship owned or controlled by You, including copyright, moral
and neighboring rights, as appropriate, for the full term of their existence including any extensions by You.
“Material” means the software or documentation made available by Us to third parties. When this Agreement
covers more than one software project, the Material means the software or documentation to which the Contribution
was Submitted. After You Submit the Contribution, it may be included in the Material.
“Submit”means any form of physical, electronic, or written communication sent to Us, including but not limited to
electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of,
Us, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not
a Contribution.”
“Submission Date” means the date You Submit a Contribution to Us.
“Documentation” means any non-software portion of a Contribution.
2. LICENSE GRANT 2.1 Copyright License to Us
Subject to the terms and conditions of this Agreement, You hereby grant to Us a worldwide, royalty-free, NON-
exclusive, perpetual and irrevocable license, with the right to transfer an unlimited number of non-exclusive licenses
Espressif Systems 1584
Submit Document Feedback
Release v4.4
To Next Page
Loading...
Need help?
General