Reflected review on public headers.

Change-Id: I0677c3e26b28c89a8b65cd1e3f2890fd914b284d
Signed-off-by: clone <ingyou.park@samsung.com>

diff --git a/inc/FUiCtrlContextMenu.h b/inc/FUiCtrlContextMenu.h
index fc4ca5d..277d90a 100755 (executable)
--- a/inc/FUiCtrlContextMenu.h
+++ b/inc/FUiCtrlContextMenu.h
@@ -98,7 +98,6 @@ enum ContextMenuAnchorDirection
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_contextmenus.htm">ContextMenu</a>.
  *
  * The following example demonstrates how to use the %ContextMenu class.
-
  *
  * @code
 // Sample code for ContextMenuSample.h
@@ -236,7 +235,8 @@ class _OSP_EXPORT_ ContextMenu
 public:
 // Lifecycle
        /**
-        * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+        * The object is not fully constructed after this constructor is called. @n
+        * For full construction, the %Construct() method must be called right after calling this constructor.
         *
         * @since       2.0
         *
@@ -263,8 +263,7 @@ public:
         * @exception   E_INVALID_STATE This instance has already been constructed.
         * @exception   E_SYSTEM            A system error has occurred.
         * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
-        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
-        * @see                 SetOwner()
+        * due to this ownership relationship. @n In this case, use the SetOwner() method to change the ownership to the top-most window.
         */
        result Construct(const Tizen::Graphics::Point& point, ContextMenuStyle style);
 
@@ -280,8 +279,7 @@ public:
         * @exception   E_INVALID_STATE This instance has already been constructed.
         * @exception   E_SYSTEM            A system error has occurred.
         * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
-        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
-        * @see                 SetOwner()
+        * due to this ownership relationship. @n In this case, use the SetOwner() method to change the ownership to the top-most window.
         */
        result Construct(const Tizen::Graphics::FloatPoint& point, ContextMenuStyle style);
 
@@ -298,8 +296,7 @@ public:
         * @exception   E_INVALID_STATE This instance has already been constructed.
         * @exception   E_SYSTEM                A system error has occurred.
         * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
-        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
-        * @see                 SetOwner()
+        * due to this ownership relationship. @n In this case, use the SetOwner() method to change the ownership to the top-most window.
         */
        result Construct(const Tizen::Graphics::Point& point, ContextMenuStyle style, ContextMenuAnchorDirection direction);
 
@@ -316,8 +313,7 @@ public:
         * @exception   E_INVALID_STATE This instance has already been constructed.
         * @exception   E_SYSTEM                A system error has occurred.
         * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
-        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
-        * @see                 SetOwner()
+        * due to this ownership relationship. @n In this case, use the SetOwner() method to change the ownership to the top-most window.
         */
        result Construct(const Tizen::Graphics::FloatPoint& point, ContextMenuStyle style, ContextMenuAnchorDirection direction);
 
@@ -355,27 +351,28 @@ public:
         * @exception   E_SUCCESS                   The method is successful.
         * @exception   E_MAX_EXCEEDED      The number of items has exceeded the maximum limit.
         * @exception   E_SYSTEM                    A system error has occurred.
-        * @remarks             This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_GRID.
+        * @remarks             This method can only be used when the style of the context menu is ::CONTEXT_MENU_STYLE_GRID.
         */
        result AddItem(const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap, int actionId);
 
-    /**
-     * Appends the specified item at the end of the %ContextMenu control.
-     *
-     * @since          2.0
-        *
-     * @return      An error code
-     * @param[in]   normalBitmap        The normal bitmap of the item
-     * @param[in]   pPressedBitmap      The pressed bitmap of the item
-     * @param[in]   pHighlightedBitmap  The highlighted bitmap of the item
-     * @param[in]   actionId            The action ID for this item
-     * @exception   E_SUCCESS           The method is successful.
-     * @exception   E_MAX_EXCEEDED      The number of items has exceeded the maximum limit.
-     * @exception   E_SYSTEM            A system error has occurred.
-     * @remarks     This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_GRID. @n
-     *                         When a user navigates the user interface using the directional keys, the selected UI control is highlighted and the control takes the
-        *                              focus.
-     */
+        /**
+        * Appends the specified item at the end of the %ContextMenu control.
+        *
+        * @since               2.0
+        *
+        * @return      An error code
+        * @param[in]   normalBitmap        The normal bitmap of the item
+        * @param[in]   pPressedBitmap      The pressed bitmap of the item
+        * @param[in]   pHighlightedBitmap  The highlighted bitmap of the item
+        * @param[in]   actionId            The action ID for this item
+        * @exception   E_SUCCESS           The method is successful.
+        * @exception   E_MAX_EXCEEDED      The number of items has exceeded the maximum limit.
+        * @exception   E_SYSTEM            A system error has occurred.
+        * @remarks     
+        *                              - This method can only be used when the style of the context menu is ::CONTEXT_MENU_STYLE_GRID.
+        *                              - When a user navigates the user interface using the directional keys, the selected UI control is highlighted and 
+        *                              the control takes the focus.
+        */
        result AddItem(const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap, const Tizen::Graphics::Bitmap* pHighlightedBitmap, int actionId);
 
        /**
@@ -401,12 +398,12 @@ public:
         * @param[in]   text                            The string of the item to append
         * @param[in]   actionId                        The specified action ID for this item
         * @param[in]   normalBitmap        The normal bitmap of the item
-     * @param[in]      pPressedBitmap      The pressed bitmap of the item
-     * @param[in]      pHighlightedBitmap  The highlighted bitmap of the item
+        * @param[in]   pPressedBitmap      The pressed bitmap of the item
+        * @param[in]   pHighlightedBitmap  The highlighted bitmap of the item
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_MAX_EXCEEDED          The total number of items has exceeded the maximum limit.
         * @exception   E_SYSTEM                        A system error has occurred.
-        * @remarks             This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_LIST.
+        * @remarks             This method can only be used when the style of the context menu is ::CONTEXT_MENU_STYLE_LIST.
         */
        result AddItem(const Tizen::Base::String& text, int actionId, const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap = null, const Tizen::Graphics::Bitmap* pHighlightedBitmap = null);
 
@@ -424,28 +421,30 @@ public:
         * @exception   E_MAX_EXCEEDED  The number of items has exceeded the maximum limit.
         * @exception   E_OUT_OF_RANGE  The specified @c index is less than @c 0 or greater than the number of items in %ContextMenu.
         * @exception   E_SYSTEM                A system error has occurred.
-        * @remarks             This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_GRID. @n
-        *                              The %ContextMenu control can have a maximum of 3 icons.
+        * @remarks             
+        *                              - This method can only be used when the style of the context menu is ::CONTEXT_MENU_STYLE_GRID.
+        *                              - The %ContextMenu control can have a maximum of @c 3 icons.
         */
        result InsertItemAt(int index, const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap, int actionId);
 
-    /**
-     * Inserts the specified item at the given index of the %ContextMenu control.
-     *
-     * @since          2.0
-        *
-     * @return         An error code
-     * @param[in]      index                      The location
-     * @param[in]      normalBitmap               The normal bitmap of the item
-     * @param[in]      pPressedBitmap             The pressed bitmap of the item
-     * @param[in]      pHighlightedBitmap         The highlighted bitmap of the item
-     * @param[in]      actionId                   The specified action ID for this item
-     * @exception      E_SUCCESS                  The method is successful.
-     * @exception      E_MAX_EXCEEDED             The number of items has exceeded the maximum limit.
-     * @exception      E_OUT_OF_RANGE             The specified @c index is less than @c 0 or greater than the number of items in %ContextMenu.
-     * @exception      E_SYSTEM                   A system error has occurred.
-     * @remarks                This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_GRID. @n
-     * @remarks                When a user navigates the user interface using the directional keys, the selected UI control is highlighted and the control takes the focus.
+        /**
+        * Inserts the specified item at the given index of the %ContextMenu control.
+        *
+        * @since               2.0
+        *
+        * @return              An error code
+        * @param[in]   index                      The location
+        * @param[in]   normalBitmap               The normal bitmap of the item
+        * @param[in]   pPressedBitmap             The pressed bitmap of the item
+        * @param[in]   pHighlightedBitmap         The highlighted bitmap of the item
+        * @param[in]   actionId                   The specified action ID for this item
+        * @exception   E_SUCCESS                  The method is successful.
+        * @exception   E_MAX_EXCEEDED             The number of items has exceeded the maximum limit.
+        * @exception   E_OUT_OF_RANGE             The specified @c index is less than @c 0 or greater than the number of items in %ContextMenu.
+        * @exception   E_SYSTEM                   A system error has occurred.
+        * @remarks             
+        *                              - This method can only be used when the style of the context menu is ::CONTEXT_MENU_STYLE_GRID.
+        *                              - When a user navigates the user interface using the directional keys, the selected UI control is highlighted and the control takes the focus.
         */
        result InsertItemAt(int index, const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap, const Tizen::Graphics::Bitmap* pHighlightedBitmap, int actionId);
 
@@ -475,13 +474,13 @@ public:
         * @param[in]   text                            The string of the item to set
         * @param[in]   actionId                        The specified action ID for this item
         * @param[in]   normalBitmap        The normal bitmap of the item
-     * @param[in]      pPressedBitmap      The pressed bitmap of the item
-     * @param[in]      pHighlightedBitmap  The highlighted bitmap of the item
+        * @param[in]   pPressedBitmap      The pressed bitmap of the item
+        * @param[in]   pHighlightedBitmap  The highlighted bitmap of the item
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_MAX_EXCEEDED          The number of items has exceeded the maximum limit.
         * @exception   E_OUT_OF_RANGE          The specified @c index is less than @c 0 or greater than the number of items in %ContextMenu.
         * @exception   E_SYSTEM                        A system error has occurred.
-        * @remarks             This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_LIST.
+        * @remarks             This method can only be used when the style of the context menu is ::CONTEXT_MENU_STYLE_LIST.
         */
        result InsertItemAt(int index, const Tizen::Base::String& text, int actionId, const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap = null, const Tizen::Graphics::Bitmap* pHighlightedBitmap = null);
 
@@ -498,7 +497,7 @@ public:
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_OUT_OF_RANGE      The specified @c index is less than @c 0 or greater than the number of items in %ContextMenu.
         * @exception   E_SYSTEM                        A system error has occurred.
-        * @remarks     This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_GRID.
+        * @remarks     This method can only be used when the style of the context menu is ::CONTEXT_MENU_STYLE_GRID.
         */
        result SetItemAt(int index, const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap, int actionId);
 
@@ -508,17 +507,18 @@ public:
         * @since           2.0
         *
         * @return        An error code
-     * @param[in]     index                      The location
-     * @param[in]     normalBitmap               The normal bitmap of the item
-     * @param[in]     pPressedBitmap             The pressed bitmap of the item
-     * @param[in]     pHighlightedBitmap         The highlighted bitmap of the item
-     * @param[in]     actionId                   The action ID for this item
-     * @exception     E_SUCCESS                  The method is successful.
-     * @exception     E_OUT_OF_RANGE             The specified @c index is less than @c 0 or greater than the number of items in %ContextMenu.
-     * @exception     E_SYSTEM                   A system error has occurred.
-     * @remarks       This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_GRID. @n
-     * @remarks       When a user navigates the user interface using the directional keys, @n
-     *                the selected UI control is highlighted and the control takes the focus.
+        * @param[in]     index                      The location
+        * @param[in]     normalBitmap               The normal bitmap of the item
+        * @param[in]     pPressedBitmap             The pressed bitmap of the item
+        * @param[in]     pHighlightedBitmap         The highlighted bitmap of the item
+        * @param[in]     actionId                   The action ID for this item
+        * @exception     E_SUCCESS                  The method is successful.
+        * @exception     E_OUT_OF_RANGE             The specified @c index is less than @c 0 or greater than the number of items in %ContextMenu.
+        * @exception     E_SYSTEM                   A system error has occurred.
+        * @remarks       
+        *                              - This method can only be used when the style of the context menu is ::CONTEXT_MENU_STYLE_GRID.
+        *                              - When a user navigates the user interface using the directional keys, @n
+        *                              the selected UI control is highlighted and the control takes the focus.
         */
        result SetItemAt(int index, const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap, const Tizen::Graphics::Bitmap* pHighlightedBitmap, int actionId);
 
@@ -552,7 +552,7 @@ public:
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_OUT_OF_RANGE          The specified @c index less than @c 0 or greater than the number of items in %ContextMenu.
         * @exception   E_SYSTEM                        A system error has occurred.
-        * @remarks     This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_LIST.
+        * @remarks     This method can only be used when the style of the context menu is ::CONTEXT_MENU_STYLE_LIST.
         */
        result SetItemAt(int index, const Tizen::Base::String& text, int actionId, const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap = null, const Tizen::Graphics::Bitmap* pHighlightedBitmap = null);
 
@@ -722,8 +722,10 @@ public:
         *                                                                      The item color for @c CONTEXT_MENU_ITEM_STATUS_NORMAL is not supported.
         * @exception   E_INVALID_STATE         This instance is in an invalid state.
         * @exception   E_SYSTEM                        A system error has occurred.
-        * @remarks             The specific error code can be accessed using the GetLastResult() method. @n
-        *                              The item color for the @c CONTEXT_MENU_ITEM_STATUS_NORMAL status is always the same as the color of the %ContextMenu control.
+        * @remarks             
+        *                              - The specific error code can be accessed using the GetLastResult() method.
+        *                              - The item color for the @c CONTEXT_MENU_ITEM_STATUS_NORMAL status is always the same as the 
+        *                              color of the %ContextMenu control.
         * @see                 SetItemColor()
         */
        Tizen::Graphics::Color GetItemColor(ContextMenuItemStatus status) const;
@@ -741,7 +743,8 @@ public:
         *                                                                      The item color for @c CONTEXT_MENU_ITEM_STATUS_NORMAL is not supported.
         * @exception   E_INVALID_STATE         This instance is in an invalid state.
         * @exception   E_SYSTEM                        A system error has occurred.
-        * @remarks             The item color for the @c CONTEXT_MENU_ITEM_STATUS_NORMAL status is always the same as the color of the %ContextMenu control.
+        * @remarks             The item color for the @c CONTEXT_MENU_ITEM_STATUS_NORMAL status is always the same 
+        *                              as the color of the %ContextMenu control.
         * @see                 GetItemColor()
         */
        result SetItemColor(ContextMenuItemStatus status, const Tizen::Graphics::Color& color);

diff --git a/inc/FUiCtrlTabBar.h b/inc/FUiCtrlTabBar.h
index 9b2aa93..f132f1b 100644 (file)
--- a/inc/FUiCtrlTabBar.h
+++ b/inc/FUiCtrlTabBar.h
@@ -161,7 +161,8 @@ class _OSP_EXPORT_ TabBar
 // Lifecycle
 public:
        /**
-        * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+        * The object is not fully constructed after this constructor is called. @n
+        * For full construction, the %Construct() method must be called right after calling this constructor.
         *
         * @since       2.0
         *
@@ -225,10 +226,11 @@ public:
         * @exception   E_MAX_EXCEEDED          The number of items has exceeded the maximum limit.
         * @exception   E_INVALID_STATE         This instance is in an invalid state.
         * @exception   E_SYSTEM                A system error has occurred.
-        * @remarks             The maximum number of items for a %TabBar control is @c 100. @n
-        *              However, the content of the specified item is copied to the %TabBar control. @n
-        *              The item can be deallocated explicitly after this method call if it is created dynamically. @n
-        *              The %TabBar control does not throw any exception even though the same action ID is assigned to multiple items.
+        * @remarks             
+        *                              - The maximum number of items for a %TabBar control is @c 100.
+        *                              - The content of the specified item is copied to the %TabBar control.
+        *                              - The item can be deallocated explicitly after this method call if it is created dynamically.
+        *                              - The %TabBar control does not throw any exception even though the same action ID is assigned to multiple items.
         */
        result AddItem(const TabBarItem& item);
 
@@ -249,10 +251,11 @@ public:
         *                                                                      The specified @c index is either greater than or equal to the number of items or is less than @c 0.
         * @exception   E_INVALID_STATE         This instance is in an invalid state.
         * @exception   E_SYSTEM                A system error has occurred.
-        * @remarks     The maximum number of items for a %TabBar control is @c 100. @n
-        *              However, the content of the specified item is copied to the @c %TabBar control. @n
-        *              The item can be deallocated explicitly after this method call if it is created dynamically. @n
-        *              The %TabBar control does not throw any exception even though the same action ID is assigned to multiple items.
+        * @remarks     
+        *                              - The maximum number of items for a %TabBar control is @c 100.
+        *                              - The content of the specified item is copied to the @c %TabBar control. @n
+        *                              - The item can be deallocated explicitly after this method call if it is created dynamically. @n
+        *                              - The %TabBar control does not throw any exception even though the same action ID is assigned to multiple items.
         */
        result InsertItemAt(int index, const TabBarItem& item);
 
@@ -386,8 +389,9 @@ public:
         *                                                                      The specified @c index is either greater than or equal to the number of items or is less than @c 0.
         * @exception   E_INVALID_STATE         This instance is in an invalid state.
         * @exception   E_SYSTEM                        A system error has occurred.
-        * @remarks     The contents of the specified item are copied. @n
-        *              The item can be deallocated explicitly after this method call if it is created dynamically.
+        * @remarks     
+        *                              - The contents of the specified item are copied.
+        *                              - The item can be deallocated explicitly after this method call if it is created dynamically.
         */
        result SetItemAt(int index, const TabBarItem& item);