resource-doc: Add overview of resource APIs

Add resource API overview in the documentation to provide information
of the resource API.

Change-Id: I94084459377629badb70c7ee36ade4f7786a1c81
Signed-off-by: Unsung Lee <unsung.lee@samsung.com>

diff --git a/doc/resource-doc.h b/doc/resource-doc.h
index 48dccac33937aa159e03518ec2cb8e4ce06a3aa9..1910318cbe4ad38a6a116307b4c9ecbffd9246b0 100644 (file)
--- a/doc/resource-doc.h
+++ b/doc/resource-doc.h
@@ -29,6 +29,26 @@
  *
  * @brief    The Resource API provides functions to control and monitor system resources.
  *
+ * @section CAPI_SYSTEM_RESOURCE_MODULE_OVERVIEW Overview
+ * The RESOURCE API provides cpu boosting or cpu resource inheritance functions.
+ *
+ * CPU boosting assigns priority to specific process on the CPU,
+ * ensuring that it is processed first. Currently, three levels of cpu boosting (WEAK, MEDIUM, STRONG) are available.
+ *
+ * The cpu boosting functions:
+ * - Setting cpu boosting level of the target
+ * - Clearing cpu boosting level of the target
+ * - Getting cpu boosting level of the target
+ *
+ * CPU resource inheritance ensures that the cpu boosting level of the destination process is equal to that of the source process.
+ * This allows for prioritization of the destination process's tasks when the source process is waiting on its operations.
+ * (e.g., IPC between source and destination processes)
+ *
+ * The cpu resource inheritance functions:
+ * - Setting cpu resource inheritance to the destination
+ * - Clearing cpu resource inheritance to the destination
+ * - Registering the destination
+ * - Unregistering the destination
  */
 
 #endif /* __TIZEN_SYSTEM_RESOURCE_DOC_H__ */