From af2b9a79ba6a908e3d252069b6d7c6a3d13a8cf6 Mon Sep 17 00:00:00 2001 From: Keuckdo Bang Date: Fri, 29 Mar 2013 13:35:53 +0900 Subject: [PATCH] Apply verified doxygen comment. Change-Id: I13513799d92305e6f860dbdcd4269540dfd80efc --- inc/FUiCtrlForm.h | 34 +++++++++++++++++----------------- inc/FUiCtrlFrame.h | 10 +++++----- inc/FUiCtrlFrameTypes.h | 8 ++++---- inc/FUiCtrlIFrameEventListener.h | 21 ++++++++++++--------- inc/FUiGridLayout.h | 6 +++--- inc/FUiRelativeLayout.h | 13 +++++++------ inc/FUiVerticalBoxLayout.h | 5 +++-- 7 files changed, 51 insertions(+), 46 deletions(-) diff --git a/inc/FUiCtrlForm.h b/inc/FUiCtrlForm.h index d05ae77..8d483e5 100644 --- a/inc/FUiCtrlForm.h +++ b/inc/FUiCtrlForm.h @@ -55,13 +55,13 @@ class IFormBackEventListener; enum FormStyle { FORM_STYLE_NORMAL = 0x00000000, /**< The basic form style */ - FORM_STYLE_TITLE = 0x00000001, /**<@if OSPDEPREC @deprecated This enumeration field is deprecated because the use of the Title control is no longer recommended.@endif */ + FORM_STYLE_TITLE = 0x00000001, /**<@if OSPDEPREC @deprecated This enum value is deprecated because the use of the Title control is no longer recommended.@endif */ FORM_STYLE_INDICATOR = 0x00000002, /**< The form with the indicator area */ - FORM_STYLE_SOFTKEY_0 = 0x00000010, /**<@if OSPDEPREC @deprecated This enumeration field is deprecated because the use of the Softkey control is no longer recommended.@endif */ - FORM_STYLE_SOFTKEY_1 = 0x00000020, /**<@if OSPDEPREC @deprecated This enumeration field is deprecated because the use of the Softkey control is no longer recommended.@endif */ - FORM_STYLE_OPTIONKEY = 0x00000040, /**<@if OSPDEPREC @deprecated This enumeration field is deprecated because the use of the Optionkey control is no longer recommended.@endif */ - FORM_STYLE_TEXT_TAB = 0x00000100, /**<@if OSPDEPREC @deprecated This enumeration field is deprecated because the use of the Tab control is no longer recommended. @endif */ - FORM_STYLE_ICON_TAB = 0x00000200, /**<@if OSPDEPREC @deprecated This enumeration field is deprecated because the use of the Tab control is no longer recommended. @endif */ + FORM_STYLE_SOFTKEY_0 = 0x00000010, /**<@if OSPDEPREC @deprecated This enum value is deprecated because the use of the Softkey control is no longer recommended.@endif */ + FORM_STYLE_SOFTKEY_1 = 0x00000020, /**<@if OSPDEPREC @deprecated This enum value is deprecated because the use of the Softkey control is no longer recommended.@endif */ + FORM_STYLE_OPTIONKEY = 0x00000040, /**<@if OSPDEPREC @deprecated This enum value is deprecated because the use of the Optionkey control is no longer recommended.@endif */ + FORM_STYLE_TEXT_TAB = 0x00000100, /**<@if OSPDEPREC @deprecated This enum value is deprecated because the use of the Tab control is no longer recommended. @endif */ + FORM_STYLE_ICON_TAB = 0x00000200, /**<@if OSPDEPREC @deprecated This enum value is deprecated because the use of the Tab control is no longer recommended. @endif */ FORM_STYLE_HEADER = 0x00001000, /**< The form with a header */ FORM_STYLE_FOOTER = 0x00002000, /**< The form with a footer */ FORM_STYLE_INDICATOR_AUTO_HIDE = 0x00010000 /**< The form with a indicator which is hidden. @b Since: @b 2.1 */ @@ -75,7 +75,7 @@ enum FormStyle * Defines the softkey. * * @brief [Deprecated] - * @deprecated This enumeration type is deprecated because the use of the Softkey control is no longer recommended. + * @deprecated This enum type is deprecated because the use of the Softkey control is no longer recommended. * @since 2.0 * @endif */ @@ -256,7 +256,7 @@ public: * * @since 2.0 * - * @param[in] listener The listener to be added + * @param[in] listener The listener to add * @remarks The %Form control can only listen to those changes to the orientation mode that are enabled by calling SetOrientation(). * @see RemoveOrientationEventListener() */ @@ -272,7 +272,7 @@ public: * @deprecated This method is deprecated because the use of the Optionkey control is no longer recommended. * @since 2.0 * - * @param[in] listener The listener to be added + * @param[in] listener The listener to add * @see RemoveOptionkeyActionListener() * @endif */ @@ -289,7 +289,7 @@ public: * @since 2.0 * * @param[in] softkey The style of the softkey - * @param[in] listener The listener to be added + * @param[in] listener The listener to add * @see RemoveSoftkeyActionListener() * @endif */ @@ -305,7 +305,7 @@ public: * @deprecated This method is deprecated because the use of the Optionkey control is no longer recommended. * @since 2.0 * - * @param[in] listener The listener to be removed + * @param[in] listener The listener to remove * @see AddOptionkeyActionListener() * @endif */ @@ -318,7 +318,7 @@ public: * * @since 2.0 * - * @param[in] listener The listener to be removed + * @param[in] listener The listener to remove * * @see AddOrientationEventListener() */ @@ -335,7 +335,7 @@ public: * @since 2.0 * * @param[in] softkey The style of the softkey - * @param[in] listener The listener to be removed + * @param[in] listener The listener to remove * @see AddSoftkeyActionListener() * @endif */ @@ -636,7 +636,7 @@ public: * @since 2.0 * * @param[in] softkey The softkey - * @param[in] actionId The action ID to be set + * @param[in] actionId The action ID to set * @endif */ void SetSoftkeyActionId(Softkey softkey, int actionId); @@ -668,7 +668,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] pTitleBitmap The title icon to be set, @n + * @param[in] pTitleBitmap The title icon to set, @n * else @c null if the title icon is removed * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of a specified operation (that is, this control cannot be displayed). @@ -688,7 +688,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] title The title to be set + * @param[in] title The title to set * @param[in] alignment The horizontal alignment * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of a specified operation (that is, this control cannot be displayed). @@ -725,7 +725,7 @@ public: * @since 2.0 * * @param[in] softkey The softkey - * @param[in] text The text to be set + * @param[in] text The text to set * @remarks If both the icon and text are set for a softkey at the same time, the text takes precedence over the icon. @n * To display text in multi-lines or to denote the end of line, use '\\n'. * @endif diff --git a/inc/FUiCtrlFrame.h b/inc/FUiCtrlFrame.h index 0744eb4..273a277 100644 --- a/inc/FUiCtrlFrame.h +++ b/inc/FUiCtrlFrame.h @@ -154,7 +154,7 @@ public: * * @since 2.0 * - * @param[in] listener The listener to be added + * @param[in] listener The listener to add * @remarks When OnOrientationChanged() event is fired, re-position and draw the child controls, but do not explicitly call * the Show() method. * @see RemoveOrientationEventListener() @@ -167,7 +167,7 @@ public: * * @since 2.0 * - * @param[in] listener The listener to be added + * @param[in] listener The listener to add * @see RemoveFrameEventListener() */ void AddFrameEventListener(Tizen::Ui::Controls::IFrameEventListener& listener); @@ -178,7 +178,7 @@ public: * * @since 2.0 * - * @param[in] listener The listener to be removed + * @param[in] listener The listener to remove * @see AddOrientationEventListener() */ void RemoveOrientationEventListener(Tizen::Ui::IOrientationEventListener& listener); @@ -189,7 +189,7 @@ public: * * @since 2.0 * - * @param[in] listener The listener to be removed + * @param[in] listener The listener to remove * @see AddFrameEventListener() */ void RemoveFrameEventListener(Tizen::Ui::Controls::IFrameEventListener& listener); @@ -215,7 +215,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] form The form to be set as the current form of the %Frame control + * @param[in] form The form to set as the current form of the %Frame control * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * The specified @c form is not a child control of the %Frame control. diff --git a/inc/FUiCtrlFrameTypes.h b/inc/FUiCtrlFrameTypes.h index ea40194..6fc71d4 100644 --- a/inc/FUiCtrlFrameTypes.h +++ b/inc/FUiCtrlFrameTypes.h @@ -37,10 +37,10 @@ namespace Tizen { namespace Ui { namespace Controls */ enum FrameShowMode { - FRAME_SHOW_MODE_FULL_SCREEN, /**< The Frame occupies the whole screen */ - FRAME_SHOW_MODE_PARTIAL_SCREEN, /**< The Frame occupies the partial screen */ - FRAME_SHOW_MODE_PARTIAL_SCREEN_FLOATING, /**< The Frame is always on top of other Frames, occupying the partial screen */ - FRAME_SHOW_MODE_MINIMIZED, /**< The Frame is minimized @b Since: @b 2.1 */ + FRAME_SHOW_MODE_FULL_SCREEN, /**< The frame occupies the whole screen */ + FRAME_SHOW_MODE_PARTIAL_SCREEN, /**< The frame occupies the partial screen */ + FRAME_SHOW_MODE_PARTIAL_SCREEN_FLOATING, /**< The frame is always on top of other frames, occupying the partial screen */ + FRAME_SHOW_MODE_MINIMIZED, /**< The frame is minimized @b Since: @b 2.1 */ }; }}} // Tizen::Ui::Controls diff --git a/inc/FUiCtrlIFrameEventListener.h b/inc/FUiCtrlIFrameEventListener.h index d3672d0..fdade26 100644 --- a/inc/FUiCtrlIFrameEventListener.h +++ b/inc/FUiCtrlIFrameEventListener.h @@ -111,30 +111,33 @@ public: // Reserves protected: // - // This method is for internal use only. Using this method can cause behavioral, security-related, - // and consistency-related issues in the application. + //This method is for internal use only. Using this method can cause behavioral, security-related, + //and consistency-related issues in the application. // - // This 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 // virtual void IFrameEventListener_Reserved3(void) {} // - // This method is for internal use only. Using this method can cause behavioral, security-related, - // and consistency-related issues in the application. + //This method is for internal use only. Using this method can cause behavioral, security-related, + //and consistency-related issues in the application. // - // This 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 // virtual void IFrameEventListener_Reserved4(void) {} // - // This method is for internal use only. Using this method can cause behavioral, security-related, - // and consistency-related issues in the application. + //This method is for internal use only. Using this method can cause behavioral, security-related, + //and consistency-related issues in the application. // - // This 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 // diff --git a/inc/FUiGridLayout.h b/inc/FUiGridLayout.h index 5456e61..a000c5d 100755 --- a/inc/FUiGridLayout.h +++ b/inc/FUiGridLayout.h @@ -84,7 +84,7 @@ GridLayoutSample::OnInitializing(void) Panel* pPanel = new Panel(); pPanel->Construct(gridPanelLayout, Rectangle((GetClientAreaBounds().width - 440)/2, (GetClientAreaBounds().height - 700)/2, 440, 700)); { - // Creates instances of Label and an instanceo of Button + // Creates instances of Label and an instance of Button Label* pLabel1 = new Label(); pLabel1->Construct(Rectangle(0, 0, 100, 200), L"Label1\n(0, 0)"); pLabel1->SetBackgroundColor(Color(0x00, 0x10, 0x80, 0xFF)); @@ -422,8 +422,8 @@ public: * @param[in] childControl The control for which the position is set * @param[in] rowStartIndex The row index * @param[in] columnStartIndex The column index - * @param[in] rowSpan The row span specifies the total number of cells in a row that are to be merged into a cell - * @param[in] columnSpan The column span specifies the total number of cells in a column that are to be merged into a cell + * @param[in] rowSpan The row span specifies the total number of cells in a row that are merged into a cell + * @param[in] columnSpan The column span specifies the total number of cells in a column that are merged into a cell * @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 diff --git a/inc/FUiRelativeLayout.h b/inc/FUiRelativeLayout.h index d224fee..62e8b38 100644 --- a/inc/FUiRelativeLayout.h +++ b/inc/FUiRelativeLayout.h @@ -37,15 +37,16 @@ namespace Tizen { namespace Ui /** * @class RelativeLayout - * @brief The relative layout positions the children of a container in a manner that is relative to other children or its parent container. + * @brief This class positions the children of a container in a manner that is relative to other children or its parent container. * * @since 2.0 * * The %RelativeLayout class defines the relative layout for a Container. The layout positions the children of the %Container relative to the - * Container or its other children. @n + * %Container or its other children. @n * * For more information on the class features, see Relative Layout. * + * The following examples demonstrate how to use the %RelativeLayout class. * @code // Sample code for RelativeLayoutSample.h #include @@ -240,7 +241,7 @@ public: * @param[in] childControl The control for which the relation is set * @param[in] targetControl The target control @n * It must be a parent or sibling. - * @param[in] edgeRelation The edge of the specified control to be aligned with the edge of the target control + * @param[in] edgeRelation The edge of the specified control to align with the edge of the target control * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. @n * Either the specified @c childControl or the specified @c targetControl is not a child of the container that owns the layout. @@ -257,7 +258,7 @@ public: * @param[in] childControl The control for which the relation is set * @param[in] pTargetControl The target control @n * It must be a parent or sibling. - * @param[in] edgeRelation The edge of the specified control to be aligned with the edge of the target control + * @param[in] edgeRelation The edge of the specified control to align with the edge of the target control * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. @n * Either the specified @c childControl or the specified @c targetControl is not a child of the container that owns the layout. @@ -286,7 +287,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] childControl The control to be center aligned + * @param[in] childControl The control to center aligned * @param[in] alignment The center alignment for a control either vertically or horizontally * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. @n @@ -302,7 +303,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] childControl The control to be center aligned + * @param[in] childControl The control to center aligned * @param[in] alignment The center alignment for a control either vertically or horizontally * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. @n diff --git a/inc/FUiVerticalBoxLayout.h b/inc/FUiVerticalBoxLayout.h index 60b707c..c42de7c 100755 --- a/inc/FUiVerticalBoxLayout.h +++ b/inc/FUiVerticalBoxLayout.h @@ -40,6 +40,7 @@ class Control; * * For more information on the class features, see Vertical and Horizontal Box Layouts. * + * The following examples demonstrate how to use the %VerticalBoxLayout class. * @code // Sample code for VerticalBoxLayoutSample.h #include @@ -123,7 +124,7 @@ VerticalBoxLayoutSample::OnInitializing(void) VerticalBoxLayout bottomPanelLayout; bottomPanelLayout.Construct(VERTICAL_DIRECTION_DOWNWARD); - // Creates an instance of Panel and applies it to the vertial box layout + // Creates an instance of Panel and applies it to the vertical box layout Panel* pBottomPanel = new Panel(); pBottomPanel->Construct(bottomPanelLayout, Rectangle(0, 0, GetClientAreaBounds().width, 450)); { @@ -202,7 +203,7 @@ public: result Construct(VerticalDirection direction); /** - * Gets the direction of the %VerticalBoxLayout. + * Gets the direction of %VerticalBoxLayout. * * @since 2.0 * -- 2.7.4