doc: move usermode API documentation
Move API reference to the main documentation section under the kernel.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
diff --git a/doc/api/kernel_api.rst b/doc/api/kernel_api.rst
index af40113..19df89b 100644
--- a/doc/api/kernel_api.rst
+++ b/doc/api/kernel_api.rst
@@ -19,12 +19,6 @@
.. doxygengroup:: kernel_apis
-Profiling
-*********
-
-.. doxygengroup:: profiling_apis
- :project: Zephyr
-
Kernel Version
**************
@@ -34,15 +28,3 @@
:project: Zephyr
:content-only:
-Memory Domain
-*************
-
-A memory domain contains some number of memory partitions. Threads can
-specify the range and attribute (access permission) for memory partitions
-in a memory domain. Threads in the same memory domain have the
-same access permissions to the memory partitions belong to the
-memory domain.
-(See :ref:`memory_domain`.)
-
-.. doxygengroup:: mem_domain_apis
- :project: Zephyr
diff --git a/doc/kernel/usermode/kernelobjects.rst b/doc/kernel/usermode/kernelobjects.rst
index b568857..1735399 100644
--- a/doc/kernel/usermode/kernelobjects.rst
+++ b/doc/kernel/usermode/kernelobjects.rst
@@ -277,16 +277,8 @@
* :option:`CONFIG_APPLICATION_MEMORY`
* :option:`CONFIG_MAX_THREAD_BYTES`
-APIs
-****
+API Reference
+*************
-* :c:func:`k_object_access_grant()`
-* :c:func:`k_object_access_revoke()`
-* :c:func:`k_object_access_all_grant()`
-* :c:func:`k_object_alloc()`
-* :c:func:`k_object_free()`
-* :c:func:`k_object_release()`
-* :c:func:`k_thread_access_grant()`
-* :c:func:`k_thread_user_mode_enter()`
-* :c:macro:`K_THREAD_ACCESS_GRANT()`
-
+.. doxygengroup:: usermode_apis
+ :project: Zephyr
diff --git a/doc/kernel/usermode/memory_domain.rst b/doc/kernel/usermode/memory_domain.rst
index dad12fb..87f7d85 100644
--- a/doc/kernel/usermode/memory_domain.rst
+++ b/doc/kernel/usermode/memory_domain.rst
@@ -176,15 +176,10 @@
* :option:`CONFIG_MAX_DOMAIN_PARTITIONS`
-APIs
-****
+API Reference
+*************
The following memory domain APIs are provided by :zephyr_file:`include/kernel.h`:
-* :c:macro:`K_MEM_PARTITION_DEFINE`
-* :cpp:func:`k_mem_domain_init()`
-* :cpp:func:`k_mem_domain_destroy()`
-* :cpp:func:`k_mem_domain_add_partition()`
-* :cpp:func:`k_mem_domain_remove_partition()`
-* :cpp:func:`k_mem_domain_add_thread()`
-* :cpp:func:`k_mem_domain_remove_thread()`
+.. doxygengroup:: mem_domain_apis
+ :project: Zephyr
diff --git a/doc/zephyr.doxyfile.in b/doc/zephyr.doxyfile.in
index 4c198e0..4de053a 100644
--- a/doc/zephyr.doxyfile.in
+++ b/doc/zephyr.doxyfile.in
@@ -1974,6 +1974,7 @@
"CONFIG_THREAD_MONITOR=y" \
"CONFIG_NET_MGMT_EVENT=y" \
"CONFIG_THREAD_CUSTOM_DATA=y" \
+ "CONFIG_SCHED_DEADLINE=y" \
"CONFIG_ERRNO=y" \
"CONFIG_THREAD_STACK_INFO=y" \
"CONFIG_UART_INTERRUPT_DRIVEN=y" \
diff --git a/include/kernel.h b/include/kernel.h
index bfa9155..09c0b52 100644
--- a/include/kernel.h
+++ b/include/kernel.h
@@ -149,6 +149,11 @@
K_OBJ_LAST
};
+/**
+ * @defgroup usermode_apis User Mode APIs
+ * @ingroup kernel_apis
+ * @{
+ */
#ifdef CONFIG_USERSPACE
/* Table generated by gperf, these objects are retrieved via
@@ -334,6 +339,8 @@
}
#endif /* CONFIG_DYNAMIC_OBJECTS */
+/** @} */
+
/* Using typedef deliberately here, this is quite intended to be an opaque
* type. K_THREAD_STACK_BUFFER() should be used to access the data within.
*
@@ -583,8 +590,7 @@
};
/**
- * @defgroup profiling_apis Profiling APIs
- * @ingroup kernel_apis
+ * @addtogroup thread_apis
* @{
*/
typedef void (*k_thread_user_cb_t)(const struct k_thread *thread,
