From: Hwankyu Jhun <h.jhun@samsung.com>
Date: Sun, 8 Sep 2019 22:13:53 +0000 (+0900)
Subject: Fix API descriptions
X-Git-Tag: accepted/tizen/5.5/unified/20191031.030641~1
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=aab6821d013ec1539485e990b64cb63c35a8871c;p=platform%2Fcore%2Fapi%2Fcomponent-manager.git

Fix API descriptions

Change-Id: I25b5315d6856c0f2d4832194e61933cab6cb0fc2
Signed-off-by: Hwankyu Jhun <h.jhun@samsung.com>
---

diff --git a/include/component_info.h b/include/component_info.h
index f40c675..3706d81 100644
--- a/include/component_info.h
+++ b/include/component_info.h
@@ -33,7 +33,7 @@ extern "C" {
 */
 
 /**
- * @brief Component information handle.
+ * @brief The component handle having own properties such name, path, and icons.
  * @since_tizen 5.5
  */
 typedef void *component_info_h;
@@ -49,7 +49,7 @@ typedef enum {
 } component_info_component_type_e;
 
 /**
- * @brief Creates the component information handle.
+ * @brief Creates a component handle.
  * @since_tizen 5.5
  * @privlevel public
  * @privilege %http://tizen.org/privilege/packagemanager.info
@@ -68,7 +68,7 @@ typedef enum {
 int component_info_create(const char *component_id, component_info_h *handle);
 
 /**
- * @brief Destroys the component information handle.
+ * @brief Destroys the component handle.
  * @since_tizen 5.5
  *
  * @param[in]   handle          The component information handle
@@ -128,7 +128,7 @@ int component_info_get_component_id(component_info_h handle, char **component_id
 int component_info_get_component_type(component_info_h handle, component_info_component_type_e *type);
 
 /**
- * @brief Checks whether the icon of the component should be displayed or not.
+ * @brief Gets whether the icon of the component is displayed on the home screen or not.
  * @since_tizen 5.5
  *
  * @param[in]   handle          The component information handle
diff --git a/include/component_manager.h b/include/component_manager.h
index d42a8a9..2aa7ed8 100644
--- a/include/component_manager.h
+++ b/include/component_manager.h
@@ -57,7 +57,7 @@ typedef enum {
 } component_manager_error_e;
 
 /**
- * @brief Called to get the component context once for each running component.
+ * @brief Called whenever the application retrieves the context of running components.
  * @since_tizen 5.5
  * @remarks The @a handle should not be released.
  *          The @a handle can be used only in the callback. To use outside, make a copy using component_context_clone().
@@ -72,7 +72,7 @@ typedef enum {
 typedef bool (*component_manager_component_context_cb)(component_context_h handle, void *user_data);
 
 /**
- * @brief Called to get the component information once for each installed component.
+ * @brief Called whenever the application retrieves the information of installed components.
  * @since_tizen 5.5
  * @remarks The @a handle should not be released.
  *          The @a handle can be used only in the callback. To use outside, make a copy using component_info_clone().