From: Yong Song Date: Fri, 14 Jun 2013 05:55:49 +0000 (+0900) Subject: revision of doxygen of some headers in app namespace X-Git-Tag: accepted/tizen/20130912.081851^2~229^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=8dca38c382e6a6eaa889c2be2ac452fc3ee95ba6;p=platform%2Fframework%2Fnative%2Fappfw.git revision of doxygen of some headers in app namespace Change-Id: I6418139a82f964f94dd1e815291e88fbda70fbbf --- diff --git a/inc/FAppISqlDataControlResponseListener.h b/inc/FAppISqlDataControlResponseListener.h index e20d38a..819d6ef 100644 --- a/inc/FAppISqlDataControlResponseListener.h +++ b/inc/FAppISqlDataControlResponseListener.h @@ -34,11 +34,11 @@ namespace Tizen { namespace App /** * @interface ISqlDataControlResponseListener -* @brief This interface defines a listener for the SQL-type data control response. +* @brief This interface defines a listener for the SQL-friendly interface based data control response. * * @since 2.0 * -* The %ISqlDataControlResponseListener interface defines a listener for the SQL-type data control response. +* The %ISqlDataControlResponseListener interface defines a listener for the SQL-friendly interface based data control response. */ class _OSP_EXPORT_ ISqlDataControlResponseListener : virtual public Tizen::Base::Runtime::IEventListener @@ -54,7 +54,7 @@ public: virtual ~ISqlDataControlResponseListener(void) {} /** - * Called when the result set is received from SQL-type data control provider. @n + * Called when the result set is received from SQL-friendly interface based data control provider. @n * The application requesting the data control can get the query result by implementing this listener. @n * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result set. * It is called after SqlDataControl::Select(). @@ -74,7 +74,7 @@ public: const Tizen::Base::String& dataId, Tizen::Io::IDbEnumerator& resultSetEnumerator, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0; /** - * Called when the response is received from SQL-type data control provider. @n + * Called when the response is received from SQL-friendly interface based data control provider. @n * The application requesting the data control can get insert result by implementing this listener. @n * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result response. * It is called after SqlDataControl::Insert(). @@ -95,7 +95,7 @@ public: const Tizen::Base::String& dataId, long long insertRowId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0; /** - * Called when the response is received from SQL-type data control provider. @n + * Called when the response is received from SQL-friendly interface based data control provider. @n * The application requesting the data control can get update result implementing this listener. @n * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result response. * It is called after SqlDataControl::Update(). @@ -114,7 +114,7 @@ public: const Tizen::Base::String& dataId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0; /** - * Called when the response is received from SQL-type data control provider. @n + * Called when the response is received from SQL-friendly interface based data control provider. @n * The application requesting the data control can get delete result by implementing this listener. @n * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result response. * It is called after SqlDataControl::Delete(). diff --git a/inc/FAppMapDataControl.h b/inc/FAppMapDataControl.h index 2c4101c..8b451ab 100755 --- a/inc/FAppMapDataControl.h +++ b/inc/FAppMapDataControl.h @@ -39,13 +39,13 @@ class IMapDataControlResponseListener; /** * @class MapDataControl - * @brief This class represents the MAP-type data control behavior. + * @brief This class represents the key-value structured data control behavior. * * @since 2.0 * * @final This class is not intended for extension. * - * The %MapDataControl class represents the MAP-type data control behavior, that provides a standard mechanism + * The %MapDataControl class represents the key-value structured data control behavior, that provides a standard mechanism * for accessing specific data exported by other applications. * Data control provider can share its own data to data control consumers. * @@ -53,6 +53,8 @@ class IMapDataControlResponseListener; * * @see Tizen::App::AppManager * + * The following example demonstrates how to use the %MapDataControl class. + * * @code * * #include @@ -109,7 +111,7 @@ public: virtual ~MapDataControl(void); /** - * Gets the value list associated with the specified @c key, from a key-values map owned by MAP-type data control provider. @n + * Gets the value list associated with the specified @c key, from a key-values map owned by key-value structured data control provider. @n * The %GetValue() method is asynchronous. * For receiving the response from data control provider, set the listener * with MapDataControl::SetMapDataControlResponseListener(). @n @@ -135,15 +137,15 @@ public: * - Access is denied due to insufficient permission. * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1 * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n - * - The size of sending buffer has exceeded the maximum limit. - * - The number of sending requests has exceeded the maximum limit. + * - The total size of method arguments has exceeded the maximum limit. + * - The number of requests sent has exceeded the maximum limit. * @exception E_SYSTEM A system error has occurred. - * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size. + * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size. */ result GetValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, RequestId& reqId, int pageNo = 1, int countPerPage = 20); /** - * Adds the value associated with the specified @c key, to a key-values map owned by MAP-type data control provider. @n + * Adds the value associated with the specified @c key, to a key-values map owned by key-value structured data control provider. @n * The %AddValue() method is asynchronous. * For receiving the response from data control provider, set the listener * with MapDataControl::SetMapDataControlResponseListener(). @n @@ -164,16 +166,16 @@ public: * - Access is denied due to insufficient permission. * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1 * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n - * - The size of sending buffer has exceeded the maximum limit. - * - The number of sending requests has exceeded the maximum limit. + * - The total size of method arguments has exceeded the maximum limit. + * - The number of requests sent has exceeded the maximum limit. * @exception E_SYSTEM A system error has occurred. - * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size. + * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size. */ result AddValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value, RequestId& reqId); /** * Sets the value associated with the specified @c key with a new value. @n - * The key-values map is owned by MAP-type data control provider. @n + * The key-values map is owned by key-value structured data control provider. @n * The %SetValue() method is asynchronous. * For receiving the response from data control provider, set the listener * with MapDataControl::SetMapDataControlResponseListener(). @n @@ -195,15 +197,15 @@ public: * - Access is denied due to insufficient permission. * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1 * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n - * - The size of sending buffer has exceeded the maximum limit. - * - The number of sending requests has exceeded the maximum limit. + * - The total size of method arguments has exceeded the maximum limit. + * - The number of requests sent has exceeded the maximum limit. * @exception E_SYSTEM A system error has occurred. - * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size. + * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size. */ result SetValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& oldValue, const Tizen::Base::String& newValue, RequestId& reqId); /** - * Removes the value associated with the specified @c key, from a key-values map owned by MAP-type data control provider. @n + * Removes the value associated with the specified @c key, from a key-values map owned by key-value structured data control provider. @n * The %RemoveValue() method is asynchronous. * For receiving the response from data control provider, set the listener * with MapDataControl::SetMapDataControlResponseListener(). @n @@ -224,10 +226,10 @@ public: * - Access is denied due to insufficient permission. * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1 * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n - * - The size of sending buffer has exceeded the maximum limit. - * - The number of sending requests has exceeded the maximum limit. + * - The total size of method arguments has exceeded the maximum limit. + * - The number of requests sent has exceeded the maximum limit. * @exception E_SYSTEM A system error has occurred. - * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size. + * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size. */ result RemoveValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value, RequestId& reqId); diff --git a/inc/FAppPkgIPackageInstallationEventListener.h b/inc/FAppPkgIPackageInstallationEventListener.h index 76e98d3..96d33bb 100755 --- a/inc/FAppPkgIPackageInstallationEventListener.h +++ b/inc/FAppPkgIPackageInstallationEventListener.h @@ -49,7 +49,10 @@ enum PackageInstallationResult * * @since 2.0 * -* The %IPackageInstallationEventListener interface defines a listener for a package installation and uninstallation. +* The %IPackageInstallationEventListener interface defines a listener that is notified for events related to installation or uninstallation of packages on a device. +* The events include installation completion, uninstallation completion, and installation progress. +* This listener is registered with the PackageManager::AddPackageInstallationEventListener() method and unregistered with the PackageManager::RemovePackageInstallationEventListener() method. +* Generally, this listener is used in system applications such as application service that utilizes packages' (un)installation information in a system. */ class _OSP_EXPORT_ IPackageInstallationEventListener : virtual public Tizen::Base::Runtime::IEventListener diff --git a/inc/FAppPkgIPackageInstallationResponseListener.h b/inc/FAppPkgIPackageInstallationResponseListener.h index 7288d00..da8e6df 100755 --- a/inc/FAppPkgIPackageInstallationResponseListener.h +++ b/inc/FAppPkgIPackageInstallationResponseListener.h @@ -37,43 +37,45 @@ namespace Tizen { namespace App { namespace Package * * @since 2.0 * - * The %IPackageInstallationResponseListener interface defines a listener for the asynchronous package installation operation. - * + * The %IPackageInstallationResponseListener interface defines a listener that is notified for events related to installation of a target package. + * The events include installation result and installation progress information. + * Generally, applications such as %Tizen Store use this listener in a package installation step. + * @see PackageManager::InstallPackage() */ class _OSP_EXPORT_ IPackageInstallationResponseListener : virtual public Tizen::Base::Runtime::IEventListener { public: /** - * This polymorphic destructor should be overridden if required. - * This way, the destructors of the derived classes are called when the destructor of this interface is called. - * - * @since 2.0 - * - */ + * This polymorphic destructor should be overridden if required. + * This way, the destructors of the derived classes are called when the destructor of this interface is called. + * + * @since 2.0 + * + */ virtual ~IPackageInstallationResponseListener(void) {} /** - * Called when a package installation is completed. @n + * Called when a package installation is completed. @n * The value of @c installationResult is @c PACKAGE_INSTALLATION_RESULT_SUCCESS if the installation is successful. - * - * @since 2.0 - * - * @param[in] packageId The package ID - * @param[in] installationResult The installation result - * - */ + * + * @since 2.0 + * + * @param[in] packageId The package ID + * @param[in] installationResult The installation result + * + */ virtual void OnPackageInstallationResponseReceived(const PackageId& packageId, PackageInstallationResult installationResult) = 0; /** - * Called when a package installation is in progress. - * - * @since 2.0 - * - * @param[in] packageId The package ID - * @param[in] progress The progress of an installation in percentage - * - */ + * Called when a package installation is in progress. + * + * @since 2.0 + * + * @param[in] packageId The package ID + * @param[in] progress The progress of an installation in percentage + * + */ virtual void OnPackageInstallationInProgressResponseReceived(const PackageId& packageId, int progress) = 0; diff --git a/inc/FAppPkgIPackageUninstallationResponseListener.h b/inc/FAppPkgIPackageUninstallationResponseListener.h index 0423a92..4609804 100755 --- a/inc/FAppPkgIPackageUninstallationResponseListener.h +++ b/inc/FAppPkgIPackageUninstallationResponseListener.h @@ -37,7 +37,10 @@ namespace Tizen { namespace App { namespace Package * * @since 2.0 * - * The %IPackageUninstallationResponseListener interface defines a listener for the asynchronous package uninstallation operation. + * The %IPackageUninstallationResponseListener interface defines a listener that is notified for events related to uninstallation of a target package. + * The events include uninstallation result. + * Generally, applications such as %Tizen Store use this listener in a package uninstallation step. + * @see PackageManager::UninstallPackage() * */ class _OSP_EXPORT_ IPackageUninstallationResponseListener @@ -45,25 +48,25 @@ class _OSP_EXPORT_ IPackageUninstallationResponseListener { public: /** - * This polymorphic destructor should be overridden if required. - * This way, the destructors of the derived classes are called when the destructor of this interface is called. - * - * @since 2.0 - * - */ + * This polymorphic destructor should be overridden if required. + * This way, the destructors of the derived classes are called when the destructor of this interface is called. + * + * @since 2.0 + * + */ virtual ~IPackageUninstallationResponseListener(void) {} /** - * Called when a package uninstallation is completed. @n + * Called when a package uninstallation is completed. @n * The value of @c uninstallationResult is @c true if the uninstallation is successful, else @c false. - * - * @since 2.0 - * - * @param[in] packageId The package ID - * @param[in] uninstallationResult Set to @c true if the uninstallation is successful, @n + * + * @since 2.0 + * + * @param[in] packageId The package ID + * @param[in] uninstallationResult Set to @c true if the uninstallation is successful, @n * else @c false - * - */ + * + */ virtual void OnPackageUninstallationResponseReceived(const PackageId& packageId, bool uninstallationResult) = 0; diff --git a/inc/FAppPkgPackageAppInfo.h b/inc/FAppPkgPackageAppInfo.h index fb77e2e..7604bd4 100755 --- a/inc/FAppPkgPackageAppInfo.h +++ b/inc/FAppPkgPackageAppInfo.h @@ -139,8 +139,8 @@ public: * @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. + * - Application can use the metadata to set app-wide information. */ Tizen::Base::Collection::IMap* GetAppMetadataListN(void) const; diff --git a/inc/FAppUiApp.h b/inc/FAppUiApp.h index 35af9a3..7886b54 100644 --- a/inc/FAppUiApp.h +++ b/inc/FAppUiApp.h @@ -146,7 +146,7 @@ public: */ Tizen::Ui::Controls::Frame* GetFrameAt(int index) const; -/** + /** * Gets the UI state of the UI application. * * @since 2.0 @@ -169,7 +169,6 @@ public: * - A system pop-up, such as an incoming call, notification (for example, SMS), or a low battery warning * pop-up disappears. * - * %OnForeground() is called when the UI application is moved to the foreground. @n * When this method is invoked, the following actions are recommended: * * - Resume the graphic processing, such as 3D or animation, as the UI application now has the focus. @@ -190,7 +189,6 @@ public: * - A device is locked. * - The Home key is pressed. * - * %OnBackground() is called when the UI application is moved to the background. @n * Whenever this method is invoked, the following actions are recommended: * * - Stop the graphic processing, such as 3D or animation, as they will not be displayed.