merge header files

Change-Id: I15913019de6adcd20e9865fa828086786cbc1219

diff --git a/inc/FShellNotificationManager.h b/inc/FShellNotificationManager.h
index 2ed262b..f0c0c82 100644 (file)
--- a/inc/FShellNotificationManager.h
+++ b/inc/FShellNotificationManager.h
@@ -79,8 +79,8 @@ static const int MAX_NOTIFICATION_TITLE_LENGTH = 1024;
  */
 enum OngoingActivityType
 {
-       ONGOING_ACTIVITY_TYPE_TEXT = 1,                         /**< The progress is indicated with a text */
-       ONGOING_ACTIVITY_TYPE_PROGRESS_BYTE,            /**< The progress is indicated with the number of bytes */
+       ONGOING_ACTIVITY_TYPE_TEXT = 1,                 /**< The progress is indicated with a text */
+       ONGOING_ACTIVITY_TYPE_PROGRESS_BYTE,    /**< The progress is indicated with the number of bytes */
        ONGOING_ACTIVITY_TYPE_PROGRESS_PERCENTAGE       /**< The progress is indicated with percentage */
 };
 
@@ -134,23 +134,23 @@ public:
        /**
         * This is the default constructor for this class.
         *
-        * @since               2.0
+        * @since       2.0
         */
        NotificationManager(void);
 
        /**
         * This destructor overrides Tizen::Base::Object::~Object().
         *
-        * @since               2.0
+        * @since       2.0
         */
        virtual ~NotificationManager(void);
 
        /**
         * Initializes this instance of %NotificationManager.
         *
-        * @since               2.0
+        * @since       2.0
         *
-        * @return              An error code
+        * @return      An error code
         * @exception   E_SUCCESS       The method is successful.
         */
        result Construct(void);
@@ -158,16 +158,16 @@ public:
        /**
         * Gets the current badge number of an application icon.
         *
-        * @since               2.0
+        * @since       2.0
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
         *
         * @return              The current badge number if the method is successful, @n
-                                       else @c -1 if the method fails
+        *                              else @c -1 if the method fails
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_OPERATION_FAILED      The operation has failed.
-        * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
-        * @remarks             The specific error code can be accessed using the GetLastResult() method.
+        * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
+        * @remarks The specific error code can be accessed using the GetLastResult() method.
         *
         */
        int GetBadgeNumber(void);
@@ -175,7 +175,7 @@ public:
        /**
         * Notifies the user who has @c badgeNumber as a badge number.
         *
-        * @since               2.0
+        * @since       2.0
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
         *
@@ -183,7 +183,7 @@ public:
         * @param[in]   badgeNumber                     The badge number
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG           The specified input parameter is invalid, or
-        *                                                                      the specified @c badgeNumber is less than @c 0.
+        *                                  the specified @c badgeNumber is less than @c 0.
         * @exception   E_OPERATION_FAILED      The operation has failed.
         * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
         */
@@ -192,7 +192,7 @@ public:
        /**
         * Notifies the user with a message.
         *
-        * @since               2.0
+        * @since       2.0
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
         *
@@ -202,14 +202,14 @@ public:
         * @exception   E_INVALID_ARG           The specified input parameter is invalid, or
         *                                                                      the length of @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
         * @exception   E_OPERATION_FAILED      The operation has failed.
-        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
+        * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
         */
        result Notify(const Tizen::Base::String& messageText);
 
        /**
         * Notifies the user who has @c badgeNumber as badge number with a message.
         *
-        * @since               2.0
+        * @since       2.0
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
         *
@@ -220,7 +220,7 @@ public:
         * @exception   E_INVALID_ARG           The specified @c badgeNumber is less than @c 0, or
         *                                                                      the length of @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
         * @exception   E_OPERATION_FAILED      The operation has failed.
-        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
+        * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
         */
        result Notify(const Tizen::Base::String& messageText, int badgeNumber);
 
@@ -230,7 +230,7 @@ public:
         * @c launchArguments is delivered as the value of the http://tizen.org/appcontrol/data/notification key
         * for IAppControlProviderEventListener::OnAppControlRequestReceived().
         *
-        * @since               2.0
+        * @since       2.0
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
         *
@@ -245,7 +245,7 @@ public:
         *                                                                      - The length of the specified @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
         *                                                                      - The length of the specified @c launchArguments is greater than Shell::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
         * @exception   E_OPERATION_FAILED      The operation has failed.
-        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
+        * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
         */
        result Notify(const Tizen::Base::String& messageText, int badgeNumber, const Tizen::Base::String& launchArguments);
 
@@ -253,19 +253,19 @@ public:
         * Notifies the user with a request message. @n
         * The notification request may have various pieces of information such as alert text, title text, launch arguments, and so on.
         *
-        * @since               2.0
+        * @since       2.0
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
         *
         * @return              An error code
-        * @param[in]   request                         The notification request
-        * @exception   E_SUCCESS                       The method is successful.
+        * @param[in]   request                 The notification request
+        * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG           Either of the following conditions has occurred: @n
         *                                                                      - The specified @c request does not have valid badge number value in @c request. @n
         *                                                                      - The specified @c request does not have alert text in @c request. @n
         *                                                                      - The specified @c request has invalid icon file path in @c request.
         * @exception   E_OPERATION_FAILED      The operation has failed.
-        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
+        * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
         */
        result Notify(const NotificationRequest& request);
 
@@ -273,44 +273,44 @@ public:
         * The user who is identified with the @c appId is notified with a request message. @n
         * The request may have various pieces of information such as alert text, title text, launch arguments, and so on.
         *
-        * @since               2.0
+        * @since       2.0
         *
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
         *
         * @return              An error code
         * @param[in]   appId                           The application ID
-        * @param[in]   request                         The notification request
-        * @exception   E_SUCCESS                       The method is successful.
+        * @param[in]   request                 The notification request
+        * @exception   E_SUCCESS               The method is successful.
         * @exception   E_APP_NOT_INSTALLED     The application is not installed.
         * @exception   E_INVALID_ARG           Either of the following conditions has occurred: @n
         *                                                                      - The specified @c request does not have valid badge number value in @c request. @n
         *                                                                      - The specified @c request does not have alert text in @c request. @n
         *                                                                      - The specified @c request has invalid icon file path in @c request.
         * @exception   E_OPERATION_FAILED      The operation has failed.
-        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
+        * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
         */
        result NotifyByAppId(const Tizen::App::AppId& appId, const NotificationRequest& request);
 
        /**
         * Removes the notification message.
         *
-        * @since               2.0
+        * @since       2.0
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
         *
         * @return              An error code
-        * @exception   E_SUCCESS                       The method is successful.
+        * @exception   E_SUCCESS       The method is successful.
         * @exception   E_OPERATION_FAILED      The operation has failed.
-        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
-        * @remarks             This method returns @c E_SUCCESS when there is no outstanding notification.
+        * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
+        * @remarks      This method returns @c E_SUCCESS when there is no outstanding notification.
         */
        result RemoveNotification(void);
 
        /**
         * Removes the notification message on behalf of the specified application.
         *
-        * @since               2.0
+        * @since       2.0
         *
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
@@ -320,7 +320,7 @@ public:
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_APP_NOT_INSTALLED     The application is not installed.
         * @exception   E_OPERATION_FAILED      The operation has failed.
-        * @exception   E_PRIVILEGE_DENIED      The application did not have the privilege to call this method.
+        * @exception   E_PRIVILEGE_DENIED  The application did not have the privilege to call this method.
         * @remarks             Although there is no outstanding notification for the calling application, this method returns @c E_SUCCESS.
         */
        result RemoveNotificationByAppId(const Tizen::App::AppId& appId);
@@ -328,7 +328,7 @@ public:
        /**
         * Notifies the user about the ongoing activity using a message.
         *
-        * @since               2.0
+        * @since       2.0
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
         *
@@ -338,7 +338,7 @@ public:
         * @exception   E_INVALID_ARG           The specified input parameter is invalid, or
         *                                                                      the length of @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
         * @exception   E_OPERATION_FAILED      The operation has failed.
-        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
+        * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
         */
        result NotifyOngoingActivity(const Tizen::Base::String& messageText);
 
@@ -348,20 +348,20 @@ public:
         * @c launchArguments is delivered as the value of the http://tizen.org/appcontrol/data/notification key
         * for IAppControlProviderEventListener::OnAppControlRequestReceived().
         *
-        * @since               2.0
+        * @since       2.0
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
         *
         * @return              An error code
         * @param[in]   messageText                     The notification message
-        * @param[in]   launchArguments         The launch arguments for the application
+        * @param[in]  launchArguments  The launch arguments for the application
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG           Either of the following conditions has occurred: @n
         *                                                                      - A specified input parameter is invalid. @n
         *                                                                      - The length of the specified @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
         *                                                                      - The length of the specified @c launchArguments is greater than Shell::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
         * @exception   E_OPERATION_FAILED      The operation has failed.
-        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
+        * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
         */
        result NotifyOngoingActivity(const Tizen::Base::String& messageText, const Tizen::Base::String& launchArguments);
 
@@ -369,18 +369,18 @@ public:
         * Notifies the user about the ongoing activity using a request message. @n
         * The request may have various pieces of information such as alert text, title text, launch arguments, and so on.
         *
-        * @since               2.0
+        * @since       2.0
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
         *
         * @return              An error code
-        * @param[in]   request                         The notification request
+        * @param[in]   request                 The notification request
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG           Either of the following conditions has occurred: @n
         *                                                                      - The specified @c request does not have either alert text or progress value in @c request. @n
         *                                                                      - The specified @c request has invalid icon file path in @c request.
         * @exception   E_OPERATION_FAILED      The operation has failed.
-        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
+        * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
         */
        result NotifyOngoingActivity(const NotificationRequest& request);
 
@@ -388,43 +388,43 @@ public:
         * Notifies the user about the ongoing activity using a request message. @n
         * The request may have various information like alert text, title text, launch arguments, and so on.
         *
-        * @since               2.0
+        * @since       2.0
         *
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
         *
         * @return              An error code
         * @param[in]   appId                           The application ID
-        * @param[in]   request                         The notification request
+        * @param[in]   request                 The notification request
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG           Either of the following conditions has occurred: @n
         *                                                                      - The specified @c request does not have either alert text or progress value in @c request. @n
         *                                                                      - The specified @c request has invalid icon file path in @c request.
         * @exception   E_APP_NOT_INSTALLED     The application is not installed.
         * @exception   E_OPERATION_FAILED      The operation has failed.
-        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
+        * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
         */
        result NotifyOngoingActivityByAppId(const Tizen::App::AppId& appId, const NotificationRequest& request);
 
        /**
         * Removes the notification message for the ongoing activity.
         *
-        * @since               2.0
+        * @since       2.0
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
         *
         * @return              An error code
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_OPERATION_FAILED      The operation has failed.
-        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
-        * @remarks             This method returns @c E_SUCCESS when there is no outstanding notification.
+        * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
+        * @remarks      This method returns @c E_SUCCESS when there is no outstanding notification.
         */
        result RemoveOngoingActivityNotification(void);
 
        /**
         * Removes the notification message for ongoing activity on behalf of the specified application.
         *
-        * @since               2.0
+        * @since       2.0
         *
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
@@ -434,7 +434,7 @@ public:
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_APP_NOT_INSTALLED     The application is not installed.
         * @exception   E_OPERATION_FAILED      The operation has failed.
-        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
+        * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
         * @remarks             Although there is no outstanding notification for the calling application, this method returns @c E_SUCCESS.
         */
        result RemoveOngoingActivityNotificationByAppId(const Tizen::App::AppId& appId);
@@ -442,7 +442,7 @@ public:
        /**
         * Gets the badge number of the application icon mentioned in the @c appId.
         *
-        * @since               2.0
+        * @since       2.0
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
         *
@@ -451,8 +451,8 @@ public:
         * @param[in]   appId                           The application ID
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_OPERATION_FAILED      The operation has failed.
-        * @exception   E_APP_NOT_INSTALLED     The application is not installed.
-        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
+        * @exception   E_APP_NOT_INSTALLED     The application is not installed.
+        * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
         * @remarks The specific error code can be accessed using the GetLastResult() method. @n
         *
         */
@@ -461,7 +461,7 @@ public:
        /**
         * Notifies the user with a message. It will disappear in a few seconds.
         *
-        * @since               2.1
+        * @since       2.1
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/notification
         *

diff --git a/inc/FShellNotificationRequest.h b/inc/FShellNotificationRequest.h
index 661acec..18dbbf4 100644 (file)
--- a/inc/FShellNotificationRequest.h
+++ b/inc/FShellNotificationRequest.h
@@ -33,13 +33,13 @@ namespace Tizen { namespace Shell
 
 /**
  * @class              NotificationRequest
- * @brief              This class provides methods for handling a notification request
+ * @brief              This class provides methods for handling a notification request.
  *
  * @since      2.0
  *
  * @final      This class is not intended for extension.
  *
- * The %NotificationRequest class provides methods for handling the notification request. The request can contain following
+ * The %NotificationRequest class provides methods for handling a notification request. The request can contain following
  * items:
  * -# Constructing element of the notification area such as a notification title or alert text
  * -# Information of the indicator area such as an alert text
@@ -316,7 +316,7 @@ public:
        int GetOngoingActivityProgress(void) const;
 
        /**
-        * Sets the progress value with the specified value.
+        * Sets the progress value with the specified @c value.
         *
         * @since       2.0
         *

diff --git a/inc/FShellQuickPanelFrame.h b/inc/FShellQuickPanelFrame.h
index 8f08c16..6671cfb 100644 (file)
--- a/inc/FShellQuickPanelFrame.h
+++ b/inc/FShellQuickPanelFrame.h
@@ -150,11 +150,11 @@ public:
         result Construct(int height);
 
         /**
-        * Initializes this instance of %QuickPanelFrame and child controls with the specified resource ID @n
+        * Initializes this instance of %QuickPanelFrame and child controls with the specified resource ID. @n
         *
         * The %Construct() method first attempts to find the resource file in the folder that corresponds to the current screen resolution. @n
         * If it fails to find the resource file, it searches in other folders in the following order when CoordinateSystem is Logical in the application manifest file @n
-        * the density folder that corresponds to the current screen size category  "res/screen-size-normal/" folder.
+        * the density folder that corresponds to the current screen size category "res/screen-size-normal/" folder.
         *
         * @since       2.0
         *
@@ -165,8 +165,8 @@ public:
         * @param[in]  resourceId                    The resource ID describing the %QuickPanelFrame control
         * @exception  E_SUCCESS                     The method is successful.
         * @exception  E_PRIVILEGE_DENIED     The application does not have the privilege to call this method.
-        * @exception  E_FILE_NOT_FOUND       The file corresponding to specified @c resourceId cannot be found.
-        * @exception  E_INVALID_FORMAT       The file format corresponding to specified @c resourceId is invalid.
+        * @exception  E_FILE_NOT_FOUND       The file corresponding to the specified @c resourceId cannot be found.
+        * @exception  E_INVALID_FORMAT       The file format corresponding to the specified @c resourceId is invalid.
         * @exception  E_OPERATION_FAILED     The operation has failed.
         */
         result Construct(const Tizen::Base::String& resourceId);
@@ -278,7 +278,7 @@ public:
         * @since       2.0
         *
         * @param[in]  listener                      The listener to remove @n
-        *                                           The listener should be referring to previously allocated instance which is passed as an argument to AddOrientationEventListener().
+        *                                           The listener should be referring to previously allocated instance that is passed as an argument to AddOrientationEventListener().
         * @exception  E_SUCCESS                     The method is successful.
         * @exception  E_OBJ_NOT_FOUND               The specified @c listener is not found.
         * @see                AddOrientationEventListener()
@@ -286,9 +286,10 @@ public:
         result RemoveOrientationEventListener(Tizen::Ui::IOrientationEventListener& listener);
 
         /**
-        * Sets the height of the %QuickPanelFrame.
+        * Sets the height of %QuickPanelFrame.
         *
         * @since       2.0
+               *
         * @return             An error code
         * @param[in]  height                        The height of %QuickPanelFrame
         * @exception  E_SUCCESS                     The method was successful.
@@ -312,8 +313,7 @@ protected:
         // This method is for internal use only. Using this method can cause behavioral, security-related,
         // and consistency-related issues in the application.
         //
-        // Following method is reserved and may change its name at any time without
-        // prior notice.
+        // This method is reserved and may change its name at any time without prior notice.
         //
         // @since      2.0
         //
@@ -323,8 +323,7 @@ protected:
         // This method is for internal use only. Using this method can cause behavioral, security-related,
         // and consistency-related issues in the application.
         //
-        // Following method is reserved and may change its name at any time without
-        // prior notice.
+        // This method is reserved and may change its name at any time without prior notice.
         //
         // @since      2.0
         //
@@ -334,8 +333,7 @@ protected:
         // This method is for internal use only. Using this method can cause behavioral, security-related,
         // and consistency-related issues in the application.
         //
-        // Following method is reserved and may change its name at any time without
-        // prior notice.
+        // This method is reserved and may change its name at any time without prior notice.
         //
         // @since      2.0
         //
@@ -345,8 +343,7 @@ protected:
         // This method is for internal use only. Using this method can cause behavioral, security-related,
         // and consistency-related issues in the application.
         //
-        // Following method is reserved and may change its name at any time without
-        // prior notice.
+        // This method is reserved and may change its name at any time without prior notice.
         //
         // @since      2.0
         //
@@ -356,8 +353,7 @@ protected:
         // This method is for internal use only. Using this method can cause behavioral, security-related,
         // and consistency-related issues in the application.
         //
-        // Following method is reserved and may change its name at any time without
-        // prior notice.
+        // This method is reserved and may change its name at any time without prior notice.
         //
         // @since      2.0
         //