OVMS3-idf/docs/api-reference
Ivan Grokhotkov cda22d9aaf 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-07 12:01:14 +08:00
..
bluetooth docs: Generate Doxygen directives for API documentation 2017-05-19 18:26:02 +02:00
ethernet docs: Generate Doxygen directives for API documentation 2017-05-19 18:26:02 +02:00
peripherals Provided more meaningful parameter names by renaming 'bit_num' to 'duty_resolution' and 'div_num' to 'clock_divider' 2017-11-15 08:08:12 +01:00
protocols docs: Generate Doxygen directives for API documentation 2017-05-19 18:26:02 +02:00
storage Add SPIFFS Component to IDF 2017-09-11 19:56:40 +03:00
system docs: add FreeRTOS API docs 2017-12-07 12:01:14 +08:00
wifi docs: Add introduction section for WiFi, replace boilerplate 2017-11-15 17:40:38 +11:00
index.rst docs: generate documentation for Kconfig options 2017-08-22 15:12:34 +08:00
kconfig.rst build system: Document --warn-undefined-variables and add a config item for it 2017-09-05 16:11:03 +10:00
template.rst docs: Generate Doxygen directives for API documentation 2017-05-19 18:26:02 +02:00