michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: kernel: flatten kernel docs and add API references

Browse source 
Instead of having kernel APIs documentated in a separate page, move the
API references to the object pages and have everything in one place.

Remove the intermediate category page and list all section under the
kernel directly.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2019-01-21 20:53:59 -05:00
commit 2dc4e270b2
26 changed files with 102 additions and 472 deletions
Download patch file Download diff file Expand all files Collapse all files

20
doc/kernel/timing/clocks.rst
View file

@ -154,20 +154,8 @@ Related configuration options:
* :option:`CONFIG_SYS_CLOCK_TICKS_PER_SEC`
APIs
****
API Reference
*************
The following kernel clock APIs are provided by :file:`kernel.h`:
* :cpp:func:`k_uptime_get()`
* :cpp:func:`k_uptime_get_32()`
* :cpp:func:`k_uptime_delta()`
* :cpp:func:`k_uptime_delta_32()`
* :cpp:func:`k_cycle_get_32()`
* :c:macro:`SYS_CLOCK_HW_CYCLES_TO_NS`
* :c:macro:`K_NO_WAIT`
* :c:macro:`K_MSEC`
* :c:macro:`K_SECONDS`
* :c:macro:`K_MINUTES`
* :c:macro:`K_HOURS`
* :c:macro:`K_FOREVER`
.. doxygengroup:: clock_apis
:project: Zephyr