mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
cda22d9aaf
- Use `code` tags instead of a mix of `<pre></pre>` and `@verbatim .. @endverbatim` - Remove manually added function prototypes from comment blocks - Remove of grouping (`\defgroup`) — some extra work is needed to make groups compatible with the way we auto-generate API reference from Doxygen XML files. It's pretty easy to add the grouping directives back if/when we implement support for Doxygen groups in the later stages of documentation build process. - Hide private APIs under `@cond .. @endcond` - Convert some comments into Doxygen-compatible ones - Fix various documentation issues: missing documentation for some parameters, mismatch between parameter names in comment block and in function prototype. - Add doxygen comments for functions which didn't have them (thread local storage). - Add [out] param tags where necessary - Redefine `xTaskCreate` and `xTaskCreateStatic` as inline functions instead of macros. |
||
|---|---|---|
| .. | ||
| _static | ||
| api-guides | ||
| api-reference | ||
| contribute | ||
| get-started | ||
| hw-reference | ||
| security | ||
| about.rst | ||
| check_doc_warnings.sh | ||
| conf.py | ||
| COPYRIGHT.rst | ||
| Doxyfile | ||
| gen-dxd.py | ||
| gen-kconfig-doc.py | ||
| index.rst | ||
| kconfiglib.py | ||
| link-roles.py | ||
| Makefile | ||
| README.md | ||
| repo_util.py | ||
| requirements.txt | ||
| resources.rst | ||
| sphinx-known-warnings.txt | ||
Documentation Source Folder
This folder contains source files of ESP-IDF documentation.
The sources do not render well in GitHub and some information is not visible at all.
Use actual documentation generated instantly on each commit:
- Main server: https://esp-idf.readthedocs.io/ or http://esp-idf.rtfd.io/
- Mirror: https://dl.espressif.com/doc/esp-idf/latest/