OVMS3-idf/docs
Ivan Grokhotkov 66fe94f816 docs: add FreeRTOS API docs
- 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.
2017-12-27 16:54:14 +08:00
..
_static Pin descriptions, overview diagram and board dimensions carried over from ESP32-PICO-KIT_Datasheet_EN.pdf. The datasheet looks redundant and will not be used. 2017-12-07 20:52:09 +08:00
api-guides freertos/fix SMP bug with Idle task clean up 2017-12-27 16:54:14 +08:00
api-reference docs: add FreeRTOS API docs 2017-12-27 16:54:14 +08:00
contribute Implement ‘blockdiag - simple block-diagram image generator’ to illustrate documentation with block diagrams, sequence diagrams, activity diagrams and logical network diagrams 2017-11-07 18:17:53 +01:00
get-started Pin descriptions, overview diagram and board dimensions carried over from ESP32-PICO-KIT_Datasheet_EN.pdf. The datasheet looks redundant and will not be used. 2017-12-07 20:52:09 +08:00
hw-reference Small updates of documentation 2017-10-31 07:36:55 +01:00
security doc: Add internal links for chapters and fix typos 2017-11-09 11:45:13 +08:00
about.rst Getting started guides 2017-04-27 19:51:42 +02:00
check_doc_warnings.sh ci: Add new check_doc_warnings.sh script, pre-process log lines 2017-09-14 13:46:35 +10:00
conf.py Implement ‘blockdiag - simple block-diagram image generator’ to illustrate documentation with block diagrams, sequence diagrams, activity diagrams and logical network diagrams 2017-11-07 18:17:53 +01:00
COPYRIGHT.rst Mass replacement of http with https urls, fixed broken urls 2017-09-06 08:16:01 +02:00
Doxyfile docs: add FreeRTOS API docs 2017-12-27 16:54:14 +08:00
gen-dxd.py docs: Generate Doxygen directives for API documentation 2017-05-19 18:26:02 +02:00
gen-kconfig-doc.py docs: generate documentation for Kconfig options 2017-08-22 15:12:34 +08:00
index.rst Getting started guides 2017-04-27 19:51:42 +02:00
kconfiglib.py Fail CI build on Sphinx warnings 2017-09-12 07:12:57 +02:00
link-roles.py docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
Makefile docs: Generate Doxygen directives for API documentation 2017-05-19 18:26:02 +02:00
README.md Mass replacement of http with https urls, fixed broken urls 2017-09-06 08:16:01 +02:00
repo_util.py docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
requirements.txt Implement ‘blockdiag - simple block-diagram image generator’ to illustrate documentation with block diagrams, sequence diagrams, activity diagrams and logical network diagrams 2017-11-07 18:17:53 +01:00
resources.rst Mass replacement of http with https urls, fixed broken urls 2017-09-06 08:16:01 +02:00
sphinx-known-warnings.txt Upgraded Sphinx to latest release 1.6.5 that contains a fix to https://github.com/sphinx-doc/sphinx/issues/4041. Upgraded Breathe to latest release 4.7.3 as well. 2017-10-31 22:57:39 +01:00

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: