pmqos: Enhance API description

To improve readability and facilitate comprehension,
more detailed API descriptions are added.

Change-Id: I398adf7bddd72818402ab6eb01f2d37fc8bcbb5b
Signed-off-by: Yunhee Seo <yuni.seo@samsung.com>

diff --git a/include/pmqos-internal.h b/include/pmqos-internal.h
index bce7d7b913b1512fcaf00924f547964cf0eb5e14..617ca1d2b015c12869f4bfde4d9f6499df71fd94 100644 (file)
--- a/include/pmqos-internal.h
+++ b/include/pmqos-internal.h
@@ -34,28 +34,56 @@ extern "C" {
  */
 
 /**
- * @brief pmqos cpu request for AppLaunchHome.
+ * @brief Request the PMQoS CPU boost for the AppLaunchHome scenario with timeout.
+ * @details The @a timeout parameter specifies the duration of the CPU boost in milliseconds.
  * @since_tizen 6.0
+ * @remarks The @a timeout parameter specifies the duration of the CPU boost in milliseconds. \n
+ *          If the timeout value exceeds @c 3000 milliseconds, it will automatically be set to @c 3000 milliseconds.
  * @param[in] timeout Timeout to change state
- * @return @c 0 on success,
- *         otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
  * @retval #DEVICE_ERROR_NONE Successful
  * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
  * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
+ * @code
+ * #include <stdio.h>
+ * #include <device/pmqos-internal.h>
+ * ...
+ * int timeout = 3000; // Timeout in milliseconds
+ * int ret = device_pmqos_app_launch_home(timeout);
+ * if (ret != DEVICE_ERROR_NONE) {
+ *     return -1;
+ * }
+ * printf("PMQoS CPU boost requested for App Launch Home scenario.\n");
+ * ...
+ * @endcode
  */
 int device_pmqos_app_launch_home(int timeout);
 
 /**
- * @brief pmqos cpu request for HomeScreen.
+ * @brief Requests the PMQoS CPU boost for the HomeScreen scenario with timeout.
+ * @details The @a timeout parameter specifies the duration of the CPU boost in milliseconds.
  * @since_tizen 6.0
+ * @remarks The @a timeout parameter specifies the duration of the CPU boost in milliseconds. \n
+ *          If the timeout value exceeds @c 3000 milliseconds, it will automatically be set to @c 3000 milliseconds.
  * @param[in] timeout Timeout to change state
- * @return @c 0 on success,
- *         otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
  * @retval #DEVICE_ERROR_NONE Successful
  * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
  * @retval #DEVICE_ERROR_NOT_SUPPORTED Not supported device
+ * @code
+ * #include <stdio.h>
+ * #include <device/pmqos.h>
+ * ...
+ * int timeout = 3000; // Timeout in milliseconds
+ * int ret = device_pmqos_homescreen(timeout);
+ * if (ret != DEVICE_ERROR_NONE) {
+ *     return -1;
+ * }
+ * printf("PMQoS CPU boost requested for Home Screen scenario.\n");
+ * ...
+ * @endcode
  */
 int device_pmqos_homescreen(int timeout);