]> granicus.if.org Git - esp-idf/commit
docs: add FreeRTOS API docs
authorIvan Grokhotkov <ivan@espressif.com>
Fri, 1 Dec 2017 04:50:45 +0000 (12:50 +0800)
committerIvan Grokhotkov <ivan@espressif.com>
Thu, 7 Dec 2017 04:01:14 +0000 (12:01 +0800)
commitcda22d9aaf553c420422cd6b3c5ecfc3ccc40a28
treef11e48bb4bd97c5e164efc64043d735e09e035f2
parent2b92119840c41156451f75effe7a328273ce3e7f
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.
components/freertos/include/freertos/event_groups.h
components/freertos/include/freertos/queue.h
components/freertos/include/freertos/ringbuf.h
components/freertos/include/freertos/semphr.h
components/freertos/include/freertos/task.h
components/freertos/include/freertos/timers.h
docs/Doxyfile
docs/api-reference/system/freertos.rst [new file with mode: 0644]
docs/api-reference/system/hooks.rst
docs/api-reference/system/index.rst