From 51032655f2722923969f50b948c26754d4f2caaa Mon Sep 17 00:00:00 2001 From: Sangyoon Jang Date: Mon, 10 Jun 2019 11:47:33 +0900 Subject: [PATCH] Fix doxygen comments of package dependency info APIs Change-Id: I6c684678293c9aeacb89c5eab3f67a0dc99e6fae Signed-off-by: Sangyoon Jang --- include/package_info.h | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/include/package_info.h b/include/package_info.h index 414ff5e..03a848e 100644 --- a/include/package_info.h +++ b/include/package_info.h @@ -153,11 +153,11 @@ typedef bool (*package_info_privilege_info_cb) (const char *privilege_name, void /** - * @brief Called to provide dependency information. + * @brief Called when dependency information between packages is retrieved. * @since_tizen 5.5 * @remarks @a from, @a to, @a type and @a required_version are managed by the platform and will be released after the callback exits. - * @param[in] from The ID of package which depends other package - * @param[in] to The ID of package which depended by other package + * @param[in] from The ID of package that depends on another + * @param[in] to The ID of package that is required by another * @param[in] type The type of dependency * @param[in] required_version The required version * @param[in] user_data The user data passed from the foreach function @@ -500,16 +500,16 @@ int package_info_foreach_cert_info(package_info_h package_info, package_info_cer int package_info_foreach_privilege_info(package_info_h package_info, package_info_privilege_info_cb callback, void *user_data); /** - * @brief Retrieves dependency information of the package. - * @details The results include packages that are only directly required by a given package. - * For example, if we have: + * @brief Retrieves dependencies between packages. + * @details @a package_info_dependency_info_cb is called whenever there is package dependency. The callback includes packages that are only directly required by the given package. + * For example, if there are packages having the following relationship: * * B --> E * A --> B --> C * D --> C * - * where A --> B means that A depends on B, and package_info_foreach_dependency_info(A) is called, - * the results will be: {from A to B}. + * A --> B means that A depends on B. + * When package_info_foreach_dependency_info(A) is called, the callback results in two parameters: @a from is A and @a to is B. * @since_tizen 5.5 * @remarks The function provides the results synchronously. If there are no dependencies, this function will return PACKAGE_MANAGER_ERROR_NONE immediately and the callback will not be invoked. * @param[in] package_info The package information @@ -524,16 +524,16 @@ int package_info_foreach_privilege_info(package_info_h package_info, package_inf int package_info_foreach_dependency_info(package_info_h package_info, package_info_dependency_info_cb callback, void *user_data); /** - * @brief Retrieves information about which packages depend on a given package. - * @details The results include packages that both directly and indirectly depend on a given package. - * For example, if we have: + * @brief Retrieves which packages depend on the given package. + * @details @a package_info_dependency_info_cb is called whenever there is package dependency. The callback includes packages that are both directly and indirectly depend on the given package. + * For example, if there are packages having the following relationship: * * B --> E * A --> B --> C * D --> C * - * where A --> B means that A depends on B, and package_info_foreach_dependency_info_depends_on(C) is called, - * the results will be: {from B to C}, {from D to C}, {from A to B}. + * A --> B means that A depends on B. + * When package_info_foreach_dependency_info(C) is called, the callback results in two parameters: @a from is B and @a to is C, @a from is D and @a to is C, @a from is A and @a to is B. * @since_tizen 5.5 * @remarks The function provides the results synchronously. If there are no dependencies, this function will return PACKAGE_MANAGER_ERROR_NONE immediately and the callback will not be invoked. * @param[in] package_info The package information -- 2.7.4