X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFAppPkgPackageAppInfo.h;h=db74266465a3735d528a38f096cb5776a92537c0;hb=07a771d39ebf4c7f26a04aeb3e06f9d7eb1c6dc2;hp=7604bd43a4ed58c573ab688ca82862e460d48ef4;hpb=e054bb27220dbf61e4cc44b1eae541db4a105780;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FAppPkgPackageAppInfo.h b/inc/FAppPkgPackageAppInfo.h index 7604bd4..db74266 100755 --- a/inc/FAppPkgPackageAppInfo.h +++ b/inc/FAppPkgPackageAppInfo.h @@ -38,13 +38,13 @@ namespace Tizen { namespace App { namespace Package /** * @class PackageAppInfo - * @brief This class represents the information of the application in package. + * @brief This class represents the information of an application in a package. * * @since 2.0 * * @final This class is not intended for extension. * - * The %PackageAppInfo class provides the information of the application in package. + * The %PackageAppInfo class provides the information of an application in a package. * */ class _OSP_EXPORT_ PackageAppInfo @@ -59,11 +59,11 @@ public: virtual ~PackageAppInfo(void); /** - * Gets an application ID. + * Gets the application ID. * * @since 2.0 * - * @return An application ID + * @return The application ID */ AppId GetAppId(void) const; @@ -72,7 +72,7 @@ public: * * @since 2.0 * - * @return The name of an application + * @return The name of the application */ Tizen::Base::String GetAppName(void) const; @@ -81,7 +81,7 @@ public: * * @since 2.0 * - * @return The display name of an application + * @return The display name of the application */ Tizen::Base::String GetAppDisplayName(void) const; @@ -90,7 +90,7 @@ public: * * @since 2.1 * - * @return The menu icon path of an application, @n + * @return The menu icon path of the application, @n * else an empty string is returned if there is no value */ Tizen::Base::String GetAppMenuIconPath(void) const; @@ -100,8 +100,8 @@ public: * * @since 2.1 * - * @return The setting icon path of an application, @n - * else an empty string is returned if there is no value + * @return The setting icon path of the application, @n + * else an empty string is returned if there is no value */ Tizen::Base::String GetAppSettingIconPath(void) const; @@ -110,7 +110,7 @@ public: * * @since 2.1 * - * @return The notification icon path of an application, @n + * @return The notification icon path of the application, @n * else an empty string is returned if there is no value */ Tizen::Base::String GetAppNotificationIconPath(void) const; @@ -118,10 +118,10 @@ public: /** * Gets the menu icon of an application. * - * @since 2.1 + * @since 2.1 * - * @return A pointer to the menu icon of an application, @n - * else @c null if it fails + * @return A pointer to the menu icon of the application, @n + * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_FILE_NOT_FOUND The menu icon does not exist. * @exception E_UNSUPPORTED_FORMAT The image file format is not supported. @@ -134,13 +134,13 @@ public: * * @since 2.1 * - * @return A pointer to a map of key(Tizen::Base::String) and value(Tizen::Base::String) pairs of the metadata, @n + * @return A pointer to the map of the key(Tizen::Base::String) and value(%Tizen::Base::String) pairs of the metadata, @n * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks - * - The specific error code can be accessed using the GetLastResult() method. - * - Application can use the metadata to set app-wide information. + * - The specific error code can be accessed using the GetLastResult() method. + * - An application can use the metadata to set the app-wide information. */ Tizen::Base::Collection::IMap* GetAppMetadataListN(void) const; @@ -158,22 +158,22 @@ public: Tizen::Base::Collection::IList* GetAppCategoryListN(void) const; /** - * Checks whether an application is visible on the menu. + * Checks if an application is visible on the menu. * * @since 2.0 * - * @return @c true if an application is visible on the menu, @n + * @return @c true if the application is visible on the menu, @n * else @c false - * @remarks If the return value is @c false, it is recommended not to display the application on the menu. + * @remarks If the return value is @c false, it is not recommended to display the application on the menu. */ bool IsMenuIconVisible(void) const; /** - * Checks whether an application is the main application of the package. + * Checks if an application is the main application of the package. * * @since 2.0 * - * @return @c true if an application is the main application of the package, @n + * @return @c true if the application is the main application of the package, @n * else @c false */ bool IsMainApp(void) const;