From f78d508d5ca36c1f99691e9acdcf0f1db70bd6dd Mon Sep 17 00:00:00 2001 From: Minkyoung Kang Date: Wed, 29 May 2013 14:31:19 +0900 Subject: [PATCH] merge the review Change-Id: I688cb5769f221d2e84674f0d981f17d25294f17b --- inc/FAppApp.h | 2 +- inc/FAppIAppControlProviderEventListener.h | 2 +- inc/FAppPkgPackageAppInfo.h | 6 +++--- inc/FAppPkgPackageManager.h | 8 ++++---- inc/FBaseBuffer.h | 14 +++++++------- inc/FBaseRtIEventArg.h | 9 ++++++--- inc/FBaseRtIEventListener.h | 2 +- inc/FBaseRtITimerEventListener.h | 1 + inc/FBaseRtMonitor.h | 2 +- inc/FBaseRtMutex.h | 4 ++-- inc/FBaseRtTypes.h | 8 ++++---- inc/FBaseRtWaitingLoop.h | 2 +- inc/FSecAccessController.h | 16 ++++++++-------- inc/FSecPrivacyInfo.h | 18 ++++++++++-------- inc/FSecPrivacyManager.h | 7 +++---- inc/FSecPrivilegeInfo.h | 10 ++++++---- inc/FSysAlarm.h | 8 ++++---- 17 files changed, 63 insertions(+), 56 deletions(-) diff --git a/inc/FAppApp.h b/inc/FAppApp.h index a5926f4..7c3495a 100644 --- a/inc/FAppApp.h +++ b/inc/FAppApp.h @@ -263,7 +263,7 @@ public: * All the activities involved in terminating the application, including saving the application's states, must be done in the %OnAppTerminating() method. * After this method, the application code cannot be executed. The application is destroyed subsequently. @n * - * An application can be terminated by either system, such as power-off and OOM, or others, such as self and other applications. @n + * An application can be terminated either by system, such as power-off and OOM, or others, such as self and other applications. @n * When the termination by system, called an “urgent termination”, occurs, the method, %OnAppTerminating(), cannot be executed properly. * For more details, while power-off, even if %OnAppTerminating() is called, it has a short time for executing. If the application is killed by OOM, %OnAppTerminating() is not called. @n * Because %OnAppTerminating() is not likely to be called due to urgent termination, the application should save the critical data as they can do. diff --git a/inc/FAppIAppControlProviderEventListener.h b/inc/FAppIAppControlProviderEventListener.h index 8b26e21..87018b0 100644 --- a/inc/FAppIAppControlProviderEventListener.h +++ b/inc/FAppIAppControlProviderEventListener.h @@ -69,7 +69,7 @@ public: * @param[in] operationId The application control operation ID * @param[in] pUriData A pointer to the URI data * @param[in] pMimeType A pointer to the MIME type (RFC 2046) data - * @param[in] pExtraData A pointer to an argument map of key and value pair where the key is of type String and the value is of type Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String + * @param[in] pExtraData A pointer to an argument map of key and value pair where the key is of type Tizen::Base::String and the value is of type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String * @remarks To reply to the application control request, use AppControlProviderManager::SendAppControlResult() with the given request ID. * @remarks When the application receives the AppControl request on the background, * %OnAppControlRequestReceived() is invoked before UiApp::OnForeground(). diff --git a/inc/FAppPkgPackageAppInfo.h b/inc/FAppPkgPackageAppInfo.h index e6ce987..fb77e2e 100755 --- a/inc/FAppPkgPackageAppInfo.h +++ b/inc/FAppPkgPackageAppInfo.h @@ -91,7 +91,7 @@ public: * @since 2.1 * * @return The menu icon path of an application, @n - * else an empty string is returned if there is no value @n + * else an empty string is returned if there is no value */ Tizen::Base::String GetAppMenuIconPath(void) const; @@ -101,7 +101,7 @@ public: * @since 2.1 * * @return The setting icon path of an application, @n - * else an empty string is returned if there is no value @n + * else an empty string is returned if there is no value */ Tizen::Base::String GetAppSettingIconPath(void) const; @@ -111,7 +111,7 @@ public: * @since 2.1 * * @return The notification icon path of an application, @n - * else an empty string is returned if there is no value @n + * else an empty string is returned if there is no value */ Tizen::Base::String GetAppNotificationIconPath(void) const; diff --git a/inc/FAppPkgPackageManager.h b/inc/FAppPkgPackageManager.h index 5003d53..4b3c98f 100755 --- a/inc/FAppPkgPackageManager.h +++ b/inc/FAppPkgPackageManager.h @@ -275,7 +275,7 @@ public: * @privlevel platform * @privilege %http://tizen.org/privilege/packagemanager.info * - * @return A pointer to the %PackageInfo instance, @n + * @return A pointer to the PackageInfo instance, @n * else @c null if it fails * @param[in] filePath The package file path * @exception E_SUCCESS The method is successful. @@ -295,7 +295,7 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/package.info * - * @return A pointer to the list of the %PackageInfo instances, @n + * @return A pointer to the list of the PackageInfo instances, @n * else @c null if it fails * @param[in] packageFilterMap The predefined key(Tizen::Base::String)-value(Tizen::Base::Boolean) pairs for the package filter @n * For more information on the predefined key-value pairs for package filter, @@ -315,7 +315,7 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/package.info * - * @return A pointer to the list of the %PackageAppInfo instances, @n + * @return A pointer to the list of the PackageAppInfo instances, @n * else @c null if it fails * @param[in] packageAppFilterMap The predefined key(Tizen::Base::String)-value(Tizen::Base::String or Tizen::Base::Boolean) pairs for the package app filter @n * For more information on the predefined key-value pairs for package app filter, @@ -335,7 +335,7 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/package.info * - * @return A pointer to the list of the %PackageAppInfo instances, @n + * @return A pointer to the list of the PackageAppInfo instances, @n * else @c null if it fails * @param[in] packageFilterMap The predefined key(Tizen::Base::String)-value(Tizen::Base::Boolean) pairs for the package filter @n * @param[in] packageAppFilterMap The predefined and user defined key(Tizen::Base::String)-value(Tizen::Base::String or Tizen::Base::Boolean) pairs for the package app filter @n diff --git a/inc/FBaseBuffer.h b/inc/FBaseBuffer.h index 15f0d9b..d52ce3a 100644 --- a/inc/FBaseBuffer.h +++ b/inc/FBaseBuffer.h @@ -772,43 +772,43 @@ private: /** - * The @c double buffer type. + * The @c double buffer type * @since 2.0 */ typedef Buffer DoubleBuffer; /** -* The @c float buffer type. +* The @c float buffer type * @since 2.0 */ typedef Buffer FloatBuffer; /** -* The @c int buffer type. +* The @c int buffer type * @since 2.0 */ typedef Buffer IntBuffer; /** -* The @c long buffer type. +* The @c long buffer type * @since 2.0 */ typedef Buffer LongBuffer; /** -* The @c long @c long buffer type. +* The @c long @c long buffer type * @since 2.0 */ typedef Buffer LongLongBuffer; /** -* The @c wchar_t buffer type. +* The @c wchar_t buffer type * @since 2.0 */ typedef Buffer WcharBuffer; /** -* The @c short buffer type. +* The @c short buffer type * @since 2.0 */ typedef Buffer ShortBuffer; diff --git a/inc/FBaseRtIEventArg.h b/inc/FBaseRtIEventArg.h index c367a0e..3137e42 100644 --- a/inc/FBaseRtIEventArg.h +++ b/inc/FBaseRtIEventArg.h @@ -16,9 +16,9 @@ /** * @file FBaseRtIEventArg.h - * @brief This is the header file for the %IEventArg class. + * @brief This is the header file for the %IEventArg interface. * - * This file contains the declarations of the %IEventArg class. + * This file contains the declarations of the %IEventArg interface. */ #ifndef _FBASE_RT_IEVENT_ARG_H_ @@ -28,8 +28,11 @@ namespace Tizen { namespace Base { namespace Runtime { /** * @interface IEventArg -* @brief This is a tagging interface that all event argument must implement. +* @brief This interface is a tagging interface that all event argument must implement. +* * @since 2.0 +* +* The %IEventArg interface is a tagging interface that all event argument must implement. */ class IEventArg { diff --git a/inc/FBaseRtIEventListener.h b/inc/FBaseRtIEventListener.h index ff2db0b..b0e248b 100644 --- a/inc/FBaseRtIEventListener.h +++ b/inc/FBaseRtIEventListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace Base { namespace Runtime /** * @interface IEventListener - * @brief This is a tagging interface that all event listeners must implement. + * @brief This interface is a tagging interface that all event listeners must implement. * * @since 2.0 * diff --git a/inc/FBaseRtITimerEventListener.h b/inc/FBaseRtITimerEventListener.h index 202cae2..f5e9e26 100644 --- a/inc/FBaseRtITimerEventListener.h +++ b/inc/FBaseRtITimerEventListener.h @@ -18,6 +18,7 @@ * @file FBaseRtITimerEventListener.h * @brief This is the header file for the %ITimerEventListener interface. * + * This header file contains the declarations of the %ITimerEventListener interface. */ #ifndef _FBASE_RT_I_TIMER_EVENT_LISTENER_H_ #define _FBASE_RT_I_TIMER_EVENT_LISTENER_H_ diff --git a/inc/FBaseRtMonitor.h b/inc/FBaseRtMonitor.h index 8e1e32c..35e2ab3 100755 --- a/inc/FBaseRtMonitor.h +++ b/inc/FBaseRtMonitor.h @@ -303,7 +303,7 @@ public: * @return An error code * @exception E_SUCCESS The method is successful in acquiring the lock. * @exception E_SYSTEM A system error has occurred. - * @remarks This method will block if called on already locked monitor object until monitor becomes availalbe. + * @remarks This method will block if called on already locked monitor object until monitor becomes available. * @see Exit() */ result Enter(void); diff --git a/inc/FBaseRtMutex.h b/inc/FBaseRtMutex.h index 197f70e..49cca8a 100755 --- a/inc/FBaseRtMutex.h +++ b/inc/FBaseRtMutex.h @@ -194,7 +194,7 @@ public: * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. - * @remarks This method will block if called on already locked monitor object until mutex becomes availalbe. + * @remarks This method will block if called on already locked monitor object until mutex becomes available. */ result Acquire(void); @@ -208,7 +208,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OBJECT_LOCKED The mutex is already locked. * @exception E_SYSTEM A system error has occurred. - * @remarks This method will block if called on already locked monitor object until mutex becomes availalbe. + * @remarks This method will block if called on already locked monitor object until mutex becomes available. */ result TryToAcquire(void); diff --git a/inc/FBaseRtTypes.h b/inc/FBaseRtTypes.h index a04817f..8cfe3d3 100644 --- a/inc/FBaseRtTypes.h +++ b/inc/FBaseRtTypes.h @@ -16,7 +16,7 @@ /** * @file FBaseRtTypes.h - * @brief This is the header file for types in the Runtime package. + * @brief This is the header file for the types in the Runtime package. * * This header file defines the types in the Runtime package. */ @@ -45,9 +45,9 @@ enum TimerStatus /** * @struct TryTag -* @brief This struct is used only for supporting non-blocking acquisition of a resource +* @brief This struct is used only for supporting non-blocking acquisition of a resource. * -* This struct is used for just discriminating between blocking and non-blocking acquisition +* The %TryTag struct is used for just discriminating between blocking and non-blocking acquisition * of a resource. So, the definition is empty. * * @since 2.0 @@ -61,7 +61,7 @@ struct TryTag }; /** -* @brief Used only for for just discriminating between blocking and non-blocking acquisition +* @brief Used only for just discriminating between blocking and non-blocking acquisition. * * @code * Mutex m; diff --git a/inc/FBaseRtWaitingLoop.h b/inc/FBaseRtWaitingLoop.h index 4a0a7f9..b8f44a4 100755 --- a/inc/FBaseRtWaitingLoop.h +++ b/inc/FBaseRtWaitingLoop.h @@ -129,7 +129,7 @@ private: WaitingLoop(const WaitingLoop& rhs); // - // The implementation of this copy assignment operator is intentionally blank and delcared as private to prohibit copying of objects. + // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects. // // @since 2.0 // diff --git a/inc/FSecAccessController.h b/inc/FSecAccessController.h index a437d0e..c53889c 100644 --- a/inc/FSecAccessController.h +++ b/inc/FSecAccessController.h @@ -54,7 +54,7 @@ public: * @exception E_DATA_NOT_FOUND The privilege information does not exist. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling the method. + * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. * @exception E_SYSTEM An unexpected system error has occurred. */ static result CheckPrivilege(int privilege); @@ -66,10 +66,10 @@ public: * @return An error code * @param[in] privilege A string of the specified privilege * @exception E_SUCCESS The method is successful and the request is granted. - * @exception E_INVALID_ARG The specified @c privilege is invalid privilege string. + * @exception E_INVALID_ARG The specified @c privilege is an invalid privilege string. * @exception E_DATA_NOT_FOUND The privilege information does not exist. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling the method. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result CheckPrivilege(const Tizen::Base::String& privilege); @@ -86,10 +86,10 @@ public: * @param[in] packageId The package ID * @param[in] privilege A string of the specified privilege * @exception E_SUCCESS The method is successful and the request is granted. - * @exception E_INVALID_ARG The specified @c privilege is invalid privilege string. + * @exception E_INVALID_ARG The specified @c privilege is an invalid privilege string. * @exception E_DATA_NOT_FOUND The privilege information does not exist. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling the method. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result CheckPrivilege(const Tizen::App::PackageId& packageId, const Tizen::Base::String& privilege); @@ -112,7 +112,7 @@ private: AccessController(const AccessController& rhs); /** - * The implementation of this copy assignment operator is intentionally blank and delcared as private to prohibit copying of objects. + * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects. */ AccessController& operator =(const AccessController& rhs); diff --git a/inc/FSecPrivacyInfo.h b/inc/FSecPrivacyInfo.h index 2111d4c..2cd714e 100755 --- a/inc/FSecPrivacyInfo.h +++ b/inc/FSecPrivacyInfo.h @@ -38,7 +38,7 @@ namespace Tizen { namespace Security * @final This class is not intended for extension. * * The %PrivacyInfo class represents the privacy information. -* %PrivacyInfo provides methods to retrieve the name and description of privilege. +* This class provides methods to retrieve the name and description of privilege. */ class _OSP_EXPORT_ PrivacyInfo @@ -75,7 +75,7 @@ public: * @param[in] enable Set to @c true to enable the privacy setting, @n * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c privacyId is invalid or the @c privacyId is not exist. + * @exception E_INVALID_ARG The specified @c privacyId is invalid or the @c privacyId does not exist. * */ result Construct(const Tizen::Base::String& privacyId, bool enable = false); @@ -85,7 +85,7 @@ public: * * @since 2.1 * - * @return The privacy ID. + * @return The privacy ID * */ Tizen::Base::String GetId(void) const; @@ -106,28 +106,30 @@ public: * * @since 2.1 * - * @param[in] enable A Boolean value indicating whether the privacy setting is enabled. + * @param[in] enable A Boolean value indicating whether the privacy setting is enabled * @see IsEnabled() * */ void SetEnabled(bool enable); /** - * Gets the localized display name of privacy. + * Gets a localized display name of privacy. * * @since 2.1 * - * @return The display name of privacy, else an empty string is returned if there is no value. + * @return The display name of privacy, @n + * else an empty string is returned if there is no value * */ Tizen::Base::String GetDisplayName(void) const; /** - * Gets the localized description of privacy. + * Gets a localized description of privacy. * * @since 2.1 * - * @return The description of privacy, else an empty string is returned if there is no value. + * @return The description of privacy, @n + * else an empty string is returned if there is no value * */ Tizen::Base::String GetDescription(void) const; diff --git a/inc/FSecPrivacyManager.h b/inc/FSecPrivacyManager.h index 71a2458..ad91939 100755 --- a/inc/FSecPrivacyManager.h +++ b/inc/FSecPrivacyManager.h @@ -106,7 +106,7 @@ public: Tizen::Base::Collection::IList* GetPrivacyInfoListN(const Tizen::App::PackageId& packageId) const; /** - * Sets the specific privacy setting of a package + * Sets a specific privacy setting of a package. * * @since 2.1 * @privlevel platform @@ -114,11 +114,10 @@ public: * * @return An error code * @param[in] packageId The package ID - * @param[in] privacyInfo The privacy setting to be set - * + * @param[in] privacyInfo The privacy information to set * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c packageId is not found in privacy database or @n - * the package did not be defined to access to the privacy information. + * the package is not defined to access the privacy information. * @exception E_INVALID_ARG The specified @c packageId length is invalid. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SYSTEM The method cannot proceed due to a severe system error. diff --git a/inc/FSecPrivilegeInfo.h b/inc/FSecPrivilegeInfo.h index 97149f5..5569c5e 100755 --- a/inc/FSecPrivilegeInfo.h +++ b/inc/FSecPrivilegeInfo.h @@ -40,7 +40,7 @@ class _PrivilegeInfoImpl; * @final This class is not intended for extension. * * The %PrivilegeInfo class represents the privilege information. -* %PrivilegeInfo provides methods to retrieve the name and description of privilege. +* This class provides methods to retrieve the name and description of privilege. * */ @@ -85,7 +85,7 @@ public: * * @since 2.1 * - * @return The privilege ID. + * @return The privilege ID * */ Tizen::Base::String GetId(void) const; @@ -95,7 +95,8 @@ public: * * @since 2.1 * - * @return The display name of privilege, else an empty string is returned if there is no value. + * @return The display name of privilege, @n + * else an empty string is returned if there is no value * */ Tizen::Base::String GetDisplayName(void) const; @@ -105,7 +106,8 @@ public: * * @since 2.1 * - * @return The description of privilege, else an empty string is returned if there is no value. + * @return The description of privilege, @n + * else an empty string is returned if there is no value * */ Tizen::Base::String GetDescription(void) const; diff --git a/inc/FSysAlarm.h b/inc/FSysAlarm.h index 4027292..460078d 100644 --- a/inc/FSysAlarm.h +++ b/inc/FSysAlarm.h @@ -85,7 +85,7 @@ public: * @privilege %http://tizen.org/privilege/alarm * * @return An error code - * @param[in] duetime The time for the alarm to ring. @n Any value with a unit that is less than a second is ignored. + * @param[in] duetime The time for the alarm to ring @n Any value with a unit that is less than a second is ignored. * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_INVALID_ARG The specified @c duetime is invalid. @@ -102,9 +102,9 @@ public: * @privilege %http://tizen.org/privilege/alarm * * @return An error code - * @param[in] start The time for the alarm to ring first. @n Any value with a unit that is less than a second is ignored. - * @param[in] period The interval in minutes between consecutive alarm rings. - * @param[in] pEnd The time for the alarm ring to end. @n Any value with a unit that is less than a second is ignored. + * @param[in] start The time for the alarm to ring first @n Any value with a unit that is less than a second is ignored. + * @param[in] period The interval in minutes between consecutive alarm rings + * @param[in] pEnd The time for the alarm ring to end @n Any value with a unit that is less than a second is ignored. * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_INVALID_ARG A specified input parameter is invalid. -- 2.7.4