From: Young Ik Cho Date: Tue, 19 Mar 2013 11:38:00 +0000 (+0900) Subject: update header review X-Git-Tag: accepted/tizen_2.1/20130425.034849~260 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=3a94caca32c413d579f8a6233bc4c95671b2f759;p=framework%2Fosp%2Fappfw.git update header review Change-Id: Ief2e80ec1f042a30be943d5d6130d8d6229f73d7 Signed-off-by: Young Ik Cho --- diff --git a/inc/FApp.h b/inc/FApp.h old mode 100644 new mode 100755 index a984aea..d88fdb7 --- a/inc/FApp.h +++ b/inc/FApp.h @@ -63,7 +63,7 @@ * @remarks @b Header @b %file: @b \#include @b @n * @b Library : @b osp-appfw * - * The %App namespace contains the classes for application development, including application life-cycle management, usage of + * The %App namespace contains classes for application development, including application life-cycle management, usage of * functionality exported by other applications through AppControl, and access to application registry and resources. Tizen * also provides various macros for debugging purposes. * @n diff --git a/inc/FAppAppManager.h b/inc/FAppAppManager.h index fd1efca..a0e0dc4 100755 --- a/inc/FAppAppManager.h +++ b/inc/FAppAppManager.h @@ -61,7 +61,7 @@ class MapDataControl; * The application manager supports normal and conditional application launch, and application control search and launch. * It looks up the specific application control from the application control registry and creates an application control instance. * @n - * For more information on the class features, see Launching Other Applications, Registering a Launch Condition, and Application Controls. + * For more information on the class features, see Launching Other Applications and Registering a Launch Condition, and Application Controls. */ class _OSP_EXPORT_ AppManager : public Tizen::Base::Object @@ -139,7 +139,7 @@ public: static Tizen::Base::Collection::IList* FindAppControlsN(const Tizen::Base::String* pOperationId, const Tizen::Base::String* pCategory, const Tizen::Base::String* pDataType, const Tizen::Base::String* pUriPattern); /** - * @if OSPDEPREC + * @if OSPDEPREC * Starts the application control if there is only one application control that matches the specified URI, operation ID, and data type. @n * If there are more than one application controls, the one that the user selects is started. * @@ -175,7 +175,7 @@ public: * String operationId = L"http://tizen.org/appcontrol/operation/call"; * StartAppControl(L"tel:1234567890", &operationId, null, null); * @endcode - * @endif + * @endif */ static result StartAppControl(const Tizen::Base::String& uriData, const Tizen::Base::String* pOperationId, const Tizen::Base::String* pDataType, IAppControlListener* pListener); @@ -227,7 +227,7 @@ public: * @param[in] providerId The provider ID * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The data control specified with the @c providerId is not found. - * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -245,7 +245,7 @@ public: * @param[in] providerId The provider ID * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The data control specified with the @c providerId is not found. - * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -279,7 +279,7 @@ public: /** * @if OSPDEPREC - * Launches the default application with given @c appId. @n + * Launches the default application with the given @c appId. @n * The launch arguments are given as App::OnUserEventReceivedN() or can be obtained by * invoking App::GetAppArgumentListN(), especially within App::OnAppInitializing(). * @@ -307,7 +307,7 @@ public: result LaunchApplication(const AppId& appId, const Tizen::Base::Collection::IList* pArguments, LaunchOption option = LAUNCH_OPTION_DEFAULT); /** - * Launches the default application with given @c appId. + * Launches the default application with the given @c appId. * * @since 2.0 * @privlevel public @@ -335,7 +335,7 @@ public: * @param[in] appId The application's ID to execute * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. - * @exception E_OBJ_NOT_FOUND The application is not installed or not running. + * @exception E_OBJ_NOT_FOUND The application is either not installed or is not running. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ result TerminateApplication(const AppId& appId); @@ -410,7 +410,7 @@ public: * @remarks Registering the same launch condition overwrites the previous launch argument without throwing an exception. * @remarks The launch period requires more consideration because an inappropriate short period value may lead * to an adverse effect on the device battery. - * @remarks For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method. + * @remarks For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method. * @see UnregisterAppLaunch() * @see IsAppLaunchRegistered() * @see LaunchApplication() @@ -527,11 +527,11 @@ public: * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * * @remarks When the registered application is about to be launched, the registered launch condition and arguments are given as parameters to IAppLaunchConditionEventListener::OnAppLaunchConditionMetN(). - * @remarks The newly introduced launch condition does not work on the previous SDK version and the E_INVALID_CONDITION exception is returned. + * @remarks The newly introduced launch condition does not work on the previous SDK version and the @c E_INVALID_CONDITION exception is returned. * @remarks Registering the same launch condition overwrites the previous launch argument without throwing an exception. * @remarks The launch period requires more consideration because an inappropriate short period value may lead * to an adverse effect on the device battery. - * @remarks For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method. + * @remarks For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method. * @see UnregisterAppLaunch() * @see IsAppLaunchRegistered() * @see LaunchApplication() diff --git a/inc/FAppAppRegistry.h b/inc/FAppAppRegistry.h old mode 100644 new mode 100755 index 9b592dc..0ea8300 --- a/inc/FAppAppRegistry.h +++ b/inc/FAppAppRegistry.h @@ -149,7 +149,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. * @exception E_KEY_ALREADY_EXIST The key has already been used in the application preferences. - * @remarks In order to save the value in the persistent storage, the AppRegistry::Save() method must be called. + * @remarks In order to save the value in the persistent storage, the Save() method must be called. */ result Add(const Tizen::Base::String& key, const Tizen::Base::String& value); @@ -164,7 +164,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. * @exception E_KEY_ALREADY_EXIST The key has already been used in the application preferences. - * @remarks In order to save the value in the persistent storage, the AppRegistry::Save() method must be called. + * @remarks In order to save the value in the persistent storage, the Save() method must be called. */ result Add(const Tizen::Base::String& key, int value); @@ -179,7 +179,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. * @exception E_KEY_ALREADY_EXIST The key has already been used in the application preferences. - * @remarks In order to save the value in the persistent storage, the AppRegistry::Save() method must be called. + * @remarks In order to save the value in the persistent storage, the Save() method must be called. */ result Add(const Tizen::Base::String& key, double value); @@ -194,7 +194,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. * @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences. - * @remarks In order to save the value in the persistent storage, the AppRegistry::Save() method must be called. + * @remarks In order to save the value in the persistent storage, the Save() method must be called. */ result Set(const Tizen::Base::String& key, const Tizen::Base::String& value); @@ -209,7 +209,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. * @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences. - * @remarks In order to save the value in the persistent storage, the AppRegistry::Save() method must be called. + * @remarks In order to save the value in the persistent storage, the Save() method must be called. */ result Set(const Tizen::Base::String& key, int value); @@ -222,9 +222,9 @@ public: * @param[in] key A key corresponding to the value * @param[in] value A floating point value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. + * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. * @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences. - * @remarks In order to save the value in the persistent storage, the AppRegistry::Save() method must be called. + * @remarks In order to save the value in the persistent storage, the Save() method must be called. */ result Set(const Tizen::Base::String& key, double value); diff --git a/inc/FAppApplication.h b/inc/FAppApplication.h old mode 100644 new mode 100755 index 0bc9c5e..ce75798 --- a/inc/FAppApplication.h +++ b/inc/FAppApplication.h @@ -19,7 +19,7 @@ * @file FAppApplication.h * @brief This is the header file for the deprecated %Application class. * - *This header file is for the deprecated %Application class. + * This header file is for the deprecated %Application class. */ #ifndef _FAPP_APPLICATION_H_ diff --git a/inc/FAppIAppControlEventListener.h b/inc/FAppIAppControlEventListener.h old mode 100644 new mode 100755 index cfab978..e5a67f5 --- a/inc/FAppIAppControlEventListener.h +++ b/inc/FAppIAppControlEventListener.h @@ -38,7 +38,7 @@ namespace Tizen { namespace App * @interface IAppControlEventListener * @brief [Deprecated] This interface defines a listener for the AppControl result events. * -* @deprecated This class is deprecated. Instead of using this interface, use the IAppControlResponseListener interface. +* @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface. * @since 2.0 * * The %IAppControlEventListener interface defines a listener for the AppControl result events. @@ -55,7 +55,7 @@ public: * * @brief [Deprecated] * - * @deprecated This class is deprecated. Instead of using this interface, use the IAppControlResponseListener interface. + * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface. * @since 2.0 * @endif */ @@ -69,7 +69,7 @@ public: * * @brief [Deprecated] * - * @deprecated This class is deprecated. Instead of using this interface, use the IAppControlResponseListener interface. + * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface. * @since 2.0 * * @param[in] providerId The provider ID diff --git a/inc/FAppIAppControlListener.h b/inc/FAppIAppControlListener.h old mode 100644 new mode 100755 index 8bfd226..2f9dbbe --- a/inc/FAppIAppControlListener.h +++ b/inc/FAppIAppControlListener.h @@ -39,7 +39,7 @@ namespace Tizen { namespace App * @interface IAppControlListener * @brief [Deprecated] This interface defines a listener for the AppControl start and result events. * - * @deprecated This class is deprecated. Instead of using this interface, use the IAppControlResponseListener interface. + * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface. * @since 2.0 * * The %IAppControlListener interface defines a listener for the AppControl start and result events. @@ -51,13 +51,13 @@ class _OSP_EXPORT_ IAppControlListener { public: /** - * @if OSPDEPREC + * @if OSPDEPREC * 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. * * @brief [Deprecated] * - * @deprecated This class is deprecated. Instead of using this interface, use the IAppControlResponseListener interface. + * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface. * @since 2.0 * @endif */ @@ -70,7 +70,7 @@ public: * * @brief [Deprecated] * - * @deprecated This class is deprecated. Instead of using this interface, use the IAppControlResponseListener interface. + * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface. * @since 2.0 * * @param[in] pAppControl A pointer to the AppControl instance that is started diff --git a/inc/FAppIAppControlResponseListener.h b/inc/FAppIAppControlResponseListener.h old mode 100644 new mode 100755 index 58302c5..ee367ba --- a/inc/FAppIAppControlResponseListener.h +++ b/inc/FAppIAppControlResponseListener.h @@ -87,7 +87,7 @@ public: * @exception E_OPERATION_CANCELED The application control resolve request is canceled by a user operation. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SYSTEM A system error has occurred. - * @remarks This method invoked only for the implicit AppControl resolution. + * @remarks This method is invoked only for the implicit AppControl resolution. * @see AppControl * @see AppControl::FindAndStart() */ diff --git a/inc/FAppIAppLaunchConditionEventListener.h b/inc/FAppIAppLaunchConditionEventListener.h old mode 100644 new mode 100755 index 9c7ecd6..2ae8f85 --- a/inc/FAppIAppLaunchConditionEventListener.h +++ b/inc/FAppIAppLaunchConditionEventListener.h @@ -41,7 +41,7 @@ namespace Tizen { namespace App * * The %IAppLaunchConditionEventListener interface defines a listener for the AppLaunchCondition events. * @n -* For more information on the class features, see Launching Other Applications, Registering a Launch Condition. +* For more information on the class features, see Launching Other Applications and Registering a Launch Condition. */ class _OSP_EXPORT_ IAppLaunchConditionEventListener : virtual public Tizen::Base::Runtime::IEventListener diff --git a/inc/FAppMapDataControl.h b/inc/FAppMapDataControl.h index 2362341..ee91c2a 100755 --- a/inc/FAppMapDataControl.h +++ b/inc/FAppMapDataControl.h @@ -156,7 +156,7 @@ public: 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. + * Removes the value associated with the specified @c key, from a key-values map owned by MAP-type data control provider. @n * The %RemoveValue() method is asynchronous. * For receiving the response from data control provider, set the listener * with MapDataControl::SetMapDataControlResponseListener(). @n @@ -168,8 +168,8 @@ public: * @return An error code * @param[in] dataId A string for identifying specific data, usually a registry section to remove from @n * The string consists of one or more components, separated by a slash('/'). - * @param[in] key A key of the value to removed - * @param[in] value A value to removed + * @param[in] key A key of the value to remove + * @param[in] value A value to remove * @param[out] reqId The ID of the request * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE This instance has not been properly constructed as yet. diff --git a/inc/FAppNotificationManager.h b/inc/FAppNotificationManager.h old mode 100644 new mode 100755 index f1435f8..63925cc --- a/inc/FAppNotificationManager.h +++ b/inc/FAppNotificationManager.h @@ -347,7 +347,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks The method returns @c E_SUCCESS when there is no outstanding notification. + * @remarks This method returns @c E_SUCCESS when there is no outstanding notification. * @endif */ result RemoveOngoingActivityNotification(void); @@ -542,7 +542,7 @@ public: /** * @if OSPDEPREC - * Removes the notification message for ongoing activity on behalf of the specified application. + * Removes the notification message for the ongoing activity on behalf of the specified application. * * @brief [Deprecated] * diff --git a/inc/FAppPkg.h b/inc/FAppPkg.h old mode 100644 new mode 100755 index a3d2587..c654bcf --- a/inc/FAppPkg.h +++ b/inc/FAppPkg.h @@ -42,6 +42,8 @@ * @b Library : @b osp-appfw * * The %Package namespace contains classes and interfaces for information of packages and management of its installation or uninstallation. + * + * The following diagram illustrates the relationships between the classes belonging to the %Package namespace. * @image html app_package_namespace_classdiagram.png */ diff --git a/inc/FAppPkgIPackageInstallationEventListener.h b/inc/FAppPkgIPackageInstallationEventListener.h old mode 100644 new mode 100755 index d1ce3e3..b504378 --- a/inc/FAppPkgIPackageInstallationEventListener.h +++ b/inc/FAppPkgIPackageInstallationEventListener.h @@ -103,7 +103,7 @@ protected: // This method is for internal use only. // Using this method can cause behavioral, security-related, and consistency-related issues in the application. // - // The following methods are reserved and the name of the methods can be changed at any time without prior notice. + // This method is reserved and may change its name at any time without prior notice. // // @since 2.0 // @@ -113,7 +113,7 @@ protected: // This method is for internal use only. // Using this method can cause behavioral, security-related, and consistency-related issues in the application. // - // The following methods are reserved and the name of the methods can be changed at any time without prior notice. + // This method is reserved and may change its name at any time without prior notice. // // @since 2.0 // @@ -123,7 +123,7 @@ protected: // This method is for internal use only. // Using this method can cause behavioral, security-related, and consistency-related issues in the application. // - // The following methods are reserved and the name of the methods can be changed at any time without prior notice. + // This method is reserved and may change its name at any time without prior notice. // // @since 2.0 // diff --git a/inc/FAppPkgIPackageUninstallationResponseListener.h b/inc/FAppPkgIPackageUninstallationResponseListener.h old mode 100644 new mode 100755 index 18b0a2b..13a53c3 --- a/inc/FAppPkgIPackageUninstallationResponseListener.h +++ b/inc/FAppPkgIPackageUninstallationResponseListener.h @@ -16,7 +16,7 @@ // /** - * @file FAppPkgIPackageUninstallationResponseListener.h + * @file FAppPkgIPackageUninstallationResponseListener.h * @brief This is the header file for the %IPackageUninstallationResponseListener interface. * * This header file contains the declarations of the %IPackageUninstallationResponseListener interface. @@ -58,7 +58,7 @@ public: * 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 + * @since 2.0 * * @param[in] packageId The package ID * @param[in] uninstallationResult Set to @c true if the uninstallation is successful, @n diff --git a/inc/FAppService.h b/inc/FAppService.h old mode 100644 new mode 100755 index 4ce919c..237efe4 --- a/inc/FAppService.h +++ b/inc/FAppService.h @@ -17,7 +17,7 @@ /** * @file FAppService.h - * @brief This is the header file of the deprecated %Service class. + * @brief This is the header file for the deprecated %Service class. * * This header file contains the declarations of the deprecated %Service class. */ diff --git a/inc/FAppServiceApp.h b/inc/FAppServiceApp.h old mode 100644 new mode 100755 index 2599850..17defdc --- a/inc/FAppServiceApp.h +++ b/inc/FAppServiceApp.h @@ -71,8 +71,8 @@ public: static ServiceApp* GetInstance(void); /** - * Executes an application implemented by inheriting this class. - * This method must be called from the entry method - OspMain(), which is generated by IDE. + * Executes an application implemented by inheriting this class. @n + * The %Execute() method must be called from the entry method - OspMain(), which is generated by IDE. * * @since 2.0 * diff --git a/inc/FAppTypes.h b/inc/FAppTypes.h old mode 100644 new mode 100755 index 0ab72f7..e3d0321 --- a/inc/FAppTypes.h +++ b/inc/FAppTypes.h @@ -79,7 +79,7 @@ enum AppState enum AppUiState { APP_UI_STATE_FOREGROUND = 0x01, /**< The application is completely visible on foreground */ - APP_UI_STATE_PARTIAL_BACKGROUND = 0x02, /**< The application is partially hidden by another window such as a system pop-up */ + APP_UI_STATE_PARTIAL_BACKGROUND = 0x02, /**< The application is partially hidden by another window, such as a system pop-up */ APP_UI_STATE_BACKGROUND = 0x04 /**< The application is completely hidden by a full-screen window, usually by another application or an application control */ }; diff --git a/inc/FAppUiApp.h b/inc/FAppUiApp.h old mode 100644 new mode 100755 index a30d589..0bf79bc --- a/inc/FAppUiApp.h +++ b/inc/FAppUiApp.h @@ -46,7 +46,7 @@ typedef UiApp* (*UiAppInstanceFactory)(void); * * The %UiApp class is the base class of a %Tizen native UI application. * A %Tizen native UI application must inherit from the %UiApp class. This class provides the basic features necessary to define the - * Tizen native UI application. + * %Tizen native UI application. * @n * For more information on the class features, see App Guide and Native Application Model. * @@ -71,7 +71,7 @@ public: * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The frame has not been properly initialized. - * @exception E_OBJ_NOT_FOUND Frame is not found. + * @exception E_OBJ_NOT_FOUND The frame is not found. */ IAppFrame* GetAppFrame(void) const;