summaryrefslogtreecommitdiff
path: root/include/app_info.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/app_info.h')
-rw-r--r--include/app_info.h26
1 files changed, 15 insertions, 11 deletions
diff --git a/include/app_info.h b/include/app_info.h
index 5200dbb..6ed44da 100644
--- a/include/app_info.h
+++ b/include/app_info.h
@@ -34,44 +34,44 @@ extern "C" {
*/
/**
- * @brief Definition for string property for filtering based on app info: String property for filtering packages with app id
+ * @brief Definition for string property for filtering based on app info: String property for filtering packages with app id.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PACKAGE_INFO_PROP_APP_ID "PACKAGE_INFO_PROP_APP_ID"
/**
- * @brief Definition for string property for filtering based on app info: String property for filtering packages with app type
+ * @brief Definition for string property for filtering based on app info: String property for filtering packages with app type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PACKAGE_INFO_PROP_APP_TYPE "PACKAGE_INFO_PROP_APP_TYPE"
/**
- * @brief Definition for string property for filtering based on app info: String property for filtering packages with app category
+ * @brief Definition for string property for filtering based on app info: String property for filtering packages with app category.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PACKAGE_INFO_PROP_APP_CATEGORY "PACKAGE_INFO_PROP_APP_CATEGORY"
/**
- * @brief Definition for string property for filtering based on app info: String property for filtering packages with installed storage of app
- * Value related with this property should be "installed_internal" or "installed_external"
+ * @brief Definition for string property for filtering based on app info: String property for filtering packages with installed storage of app.
+ * Value related with this property should be "installed_internal" or "installed_external".
* @since_tizen 3.0
*/
#define PACKAGE_INFO_PROP_APP_INSTALLED_STORAGE "PACKAGE_INFO_PROP_APP_INSTALLED_STORAGE"
/**
- * @brief Definition for boolean property for filtering based on app info: Boolean property for filtering whether the package is nodisplay or not based on package info
+ * @brief Definition for boolean property for filtering based on app info: Boolean property for filtering whether the package is nodisplay or not based on package info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PACKAGE_INFO_PROP_APP_NODISPLAY "PACKAGE_INFO_PROP_APP_NODISPLAY"
/**
- * @brief Definition for boolean property for filtering based on app info: Boolean property for filtering whether the package has the authority to manage task or not based on package info
+ * @brief Definition for boolean property for filtering based on app info: Boolean property for filtering whether the package has the authority to manage task or not based on package info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PACKAGE_INFO_PROP_APP_TASKMANAGE "PACKAGE_INFO_PROP_APP_TASKMANAGE"
/**
- * @brief Definition for boolean property for filtering based on app info: Boolean property for filtering whether the application has been disabled
+ * @brief Definition for boolean property for filtering based on app info: Boolean property for filtering whether the application has been disabled.
* @since_tizen 4.0
*/
#define PACKAGE_INFO_PROP_APP_DISABLED "PACKAGE_INFO_PROP_APP_DISABLED"
@@ -89,10 +89,10 @@ extern "C" {
/**
* @brief Enumeration for application component type.
- * @since_tizen 4.0
* @details A component is an application considered as a part of a package.
* The application component type indicates what type of
* a component an application is in a package.
+ * @since_tizen 4.0
* @see PACKAGE_INFO_PROP_APP_COMPONENT_TYPE
* @see app_info_get_app_component_type()
*/
@@ -164,6 +164,7 @@ typedef bool (*app_info_category_cb) (const char *category, void *user_data);
/**
* @brief Creates the application information handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a app_info should be released using app_info_destroy().
* @param[in] app_id The application ID
* @param[out] app_info The application information handle
* @return @c 0 on success,
@@ -205,7 +206,7 @@ int app_info_destroy(app_info_h app_info);
int app_info_get_app_id(app_info_h app_info, char **app_id);
/**
- * @brief Gets the executable path of the application
+ * @brief Gets the executable path of the application.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a exec path using free().
* @param[in] app_info The application information
@@ -400,6 +401,7 @@ int app_info_is_support_ambient(app_info_h app_info, bool *ambient_supported);
/**
* @brief Clones the application information handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a clone should be released using app_info_destroy().
* @param[out] clone A newly created application information handle, if successfully cloned
* @param[in] app_info The application information
* @return @c 0 on success,
@@ -423,9 +425,9 @@ int app_info_clone(app_info_h *clone, app_info_h app_info);
* @return @c 0 on success,
* otherwise a negative error value
* @retval #APP_MANAGER_ERROR_NONE Successful
+ * @retval #APP_MANAGER_ERROR_PERMISSION_DENIED Permission denied
* @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_MANAGER_ERROR_IO_ERROR I/O error
- * @retval #APP_MANAGER_ERROR_PERMISSION_DENIED Permission denied
* @see app_info_create()
*/
int app_info_foreach_category(app_info_h app_info, app_info_category_cb callback, void *user_data);
@@ -434,6 +436,7 @@ int app_info_foreach_category(app_info_h app_info, app_info_category_cb callback
* @brief Creates the application information filter handle from DB.
* All filter properties will be ANDed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a handle should be released using app_info_filter_destroy().
* @param[out] handle The pointer to the application info filter handle
* @return @c 0 on success,
* otherwise a negative error value
@@ -514,6 +517,7 @@ int app_info_filter_foreach_appinfo(app_info_filter_h handle, app_info_filter_cb
/**
* @brief Creates the application's metadata information filter handle from DB.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a handle should be released using app_info_metadata_filter_destroy().
* @param[out] handle The pointer to the application metadata info filter handle
* @return @c 0 on success,
* otherwise a negative error value