resource-monitor: Add @see tag to indicate the related capi

Change-Id: Icc3664b8f1a5a1bbeef153a885638e2189eee636
Signed-off-by: Chanwoo Choi <cw00.choi@samsung.com>

diff --git a/include/resource-monitor.h b/include/resource-monitor.h
index a02a0dc49dae1885cc8b65f7322818e3d3fe322c..f089c2c033c10502639991e2d674c56929a3b50e 100644 (file)
--- a/include/resource-monitor.h
+++ b/include/resource-monitor.h
@@ -177,6 +177,7 @@ typedef enum {
  * @retval #RESOURCE_MONITOR_ERROR_NOT_SUPPORTED                Not Supported
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_exit()
  */
 int resource_monitor_init(void);
 
@@ -190,6 +191,7 @@ int resource_monitor_init(void);
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
  */
 int resource_monitor_exit(int monitor_id);
 
@@ -205,6 +207,7 @@ int resource_monitor_exit(int monitor_id);
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
  */
 int resource_monitor_get_resource_count(int monitor_id, resource_monitor_type_e resource_type, int *resource_count);
 
@@ -220,6 +223,8 @@ int resource_monitor_get_resource_count(int monitor_id, resource_monitor_type_e
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_delete_resource()
  */
 int resource_monitor_create_resource(int monitor_id, resource_monitor_type_e resource_type);
 
@@ -234,6 +239,8 @@ int resource_monitor_create_resource(int monitor_id, resource_monitor_type_e res
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
  */
 int resource_monitor_delete_resource(int monitor_id, int resource_id);
 
@@ -250,6 +257,8 @@ int resource_monitor_delete_resource(int monitor_id, int resource_id);
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
  */
 int resource_monitor_set_resource_ctrl(int monitor_id, int resource_id, resource_monitor_ctrl_id_e ctrl_id, int value);
 
@@ -265,6 +274,9 @@ int resource_monitor_set_resource_ctrl(int monitor_id, int resource_id, resource
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_unset_resource_attr()
  */
 int resource_monitor_set_resource_attr(int monitor_id, int resource_id, resource_monitor_attr_id_e attr_mask);
 
@@ -280,6 +292,9 @@ int resource_monitor_set_resource_attr(int monitor_id, int resource_id, resource
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
  */
 int resource_monitor_unset_resource_attr(int monitor_id, int resource_id, resource_monitor_attr_id_e attr_mask);
 
@@ -296,6 +311,9 @@ int resource_monitor_unset_resource_attr(int monitor_id, int resource_id, resour
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
  */
 int resource_monitor_is_resource_attr_supported(int monitor_id, int resource_id, resource_monitor_attr_id_e attr_id, bool *supported);
 
@@ -309,6 +327,10 @@ int resource_monitor_is_resource_attr_supported(int monitor_id, int resource_id,
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
+ * @see    resource_monitor_set_resource_ctrl()
  */
 int resource_monitor_update(int monitor_id);
 
@@ -323,6 +345,10 @@ int resource_monitor_update(int monitor_id);
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
+ * @see    resource_monitor_set_resource_ctrl()
  */
 int resource_monitor_update_resource(int monitor_id, int resource_id);
 
@@ -339,6 +365,12 @@ int resource_monitor_update_resource(int monitor_id, int resource_id);
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
+ * @see    resource_monitor_set_resource_ctrl()
+ * @see    resource_monitor_update()
+ * @see    resource_monitor_update_resource()
  */
 int resource_monitor_get_value_int(int monitor_id, int resource_id, resource_monitor_attr_id_e attr_id, int32_t *value);
 
@@ -355,6 +387,12 @@ int resource_monitor_get_value_int(int monitor_id, int resource_id, resource_mon
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
+ * @see    resource_monitor_set_resource_ctrl()
+ * @see    resource_monitor_update()
+ * @see    resource_monitor_update_resource()
  */
 int resource_monitor_get_value_int64(int monitor_id, int resource_id, resource_monitor_attr_id_e attr_id, int64_t *value);
 
@@ -371,6 +409,12 @@ int resource_monitor_get_value_int64(int monitor_id, int resource_id, resource_m
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
+ * @see    resource_monitor_set_resource_ctrl()
+ * @see    resource_monitor_update()
+ * @see    resource_monitor_update_resource()
  */
 int resource_monitor_get_value_uint32(int monitor_id, int resource_id, resource_monitor_attr_id_e attr_id, u_int32_t *value);
 
@@ -387,6 +431,12 @@ int resource_monitor_get_value_uint32(int monitor_id, int resource_id, resource_
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
+ * @see    resource_monitor_set_resource_ctrl()
+ * @see    resource_monitor_update()
+ * @see    resource_monitor_update_resource()
  */
 int resource_monitor_get_value_uint64(int monitor_id, int resource_id, resource_monitor_attr_id_e attr_id, u_int64_t *value);
 
@@ -403,6 +453,12 @@ int resource_monitor_get_value_uint64(int monitor_id, int resource_id, resource_
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
+ * @see    resource_monitor_set_resource_ctrl()
+ * @see    resource_monitor_update()
+ * @see    resource_monitor_update_resource()
  */
 int resource_monitor_get_value_double(int monitor_id, int resource_id, resource_monitor_attr_id_e attr_id, double *value);
 
@@ -420,6 +476,12 @@ int resource_monitor_get_value_double(int monitor_id, int resource_id, resource_
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
+ * @see    resource_monitor_set_resource_ctrl()
+ * @see    resource_monitor_update()
+ * @see    resource_monitor_update_resource()
  */
 int resource_monitor_get_value_string(int monitor_id, int resource_id, resource_monitor_attr_id_e attr_id, char **value);
 
@@ -438,6 +500,12 @@ int resource_monitor_get_value_string(int monitor_id, int resource_id, resource_
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
+ * @see    resource_monitor_set_resource_ctrl()
+ * @see    resource_monitor_update()
+ * @see    resource_monitor_update_resource()
  */
 int resource_monitor_get_array_int(int monitor_id, int resource_id, resource_monitor_attr_id_e attr_id, int32_t **array, int *length);
 
@@ -456,6 +524,12 @@ int resource_monitor_get_array_int(int monitor_id, int resource_id, resource_mon
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
+ * @see    resource_monitor_set_resource_ctrl()
+ * @see    resource_monitor_update()
+ * @see    resource_monitor_update_resource()
  */
 int resource_monitor_get_array_int64(int monitor_id, int resource_id, resource_monitor_attr_id_e attr_id, int64_t **array, int *length);
 
@@ -474,6 +548,12 @@ int resource_monitor_get_array_int64(int monitor_id, int resource_id, resource_m
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
+ * @see    resource_monitor_set_resource_ctrl()
+ * @see    resource_monitor_update()
+ * @see    resource_monitor_update_resource()
  */
 int resource_monitor_get_array_uint32(int monitor_id, int resource_id, resource_monitor_attr_id_e attr_id, u_int32_t **array, int *length);
 
@@ -492,6 +572,12 @@ int resource_monitor_get_array_uint32(int monitor_id, int resource_id, resource_
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
+ * @see    resource_monitor_set_resource_ctrl()
+ * @see    resource_monitor_update()
+ * @see    resource_monitor_update_resource()
  */
 int resource_monitor_get_array_uint64(int monitor_id, int resource_id, resource_monitor_attr_id_e attr_id, u_int64_t **array, int *length);
 
@@ -510,6 +596,12 @@ int resource_monitor_get_array_uint64(int monitor_id, int resource_id, resource_
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
+ * @see    resource_monitor_set_resource_ctrl()
+ * @see    resource_monitor_update()
+ * @see    resource_monitor_update_resource()
  */
 int resource_monitor_get_array_double(int monitor_id, int resource_id, resource_monitor_attr_id_e attr_id, double **array, int *length);
 
@@ -528,6 +620,12 @@ int resource_monitor_get_array_double(int monitor_id, int resource_id, resource_
  * @retval #RESOURCE_MONITOR_ERROR_INVALID_PARAMETER            Invalid Parameter
  * @retval #RESOURCE_MONITOR_ERROR_NO_DATA                      Empty Data
  * @retval #RESOURCE_MONITOR_ERROR_OUT_OF_MEMORY                Out of Memory
+ * @see    resource_monitor_init()
+ * @see    resource_monitor_create_resource()
+ * @see    resource_monitor_set_resource_attr()
+ * @see    resource_monitor_set_resource_ctrl()
+ * @see    resource_monitor_update()
+ * @see    resource_monitor_update_resource()
  */
 int resource_monitor_get_array_string(int monitor_id, int resource_id, resource_monitor_attr_id_e attr_id, char ***array, int *length);