From 7722c720f90f448f79844fad8855e0798f43b288 Mon Sep 17 00:00:00 2001 From: Minkyoung Kang Date: Fri, 21 Jun 2013 11:54:14 +0900 Subject: [PATCH] update header for Doxygen Change-Id: I773bada8d25d00ce87c83d5edf13b78ec2b7738f --- inc/FGrpBitmap.h | 4 ++-- inc/FGrpCanvas.h | 8 ++++---- inc/FUiCtrlGroupedTableView.h | 9 ++++++--- inc/FUiCtrlICustomElement.h | 1 - inc/FUiCtrlICustomElementF.h | 1 - inc/FUiCtrlIGroupedListViewItemProvider.h | 3 ++- inc/FUiCtrlSectionTableView.h | 3 ++- 7 files changed, 16 insertions(+), 13 deletions(-) diff --git a/inc/FGrpBitmap.h b/inc/FGrpBitmap.h index dc46bab..235fd00 100644 --- a/inc/FGrpBitmap.h +++ b/inc/FGrpBitmap.h @@ -523,9 +523,9 @@ public: /** * Locks a bitmap for direct pixel access. @n - * It sets up a bitmap for accessing the pixels directly. Between the calls to Bitmap::Lock and Bitmap::Unlock, + * It sets up a bitmap for accessing the pixels directly. Between the calls to Bitmap::Lock() and Bitmap::Unlock(), * you can write to and read from the bitmap's pixels. After you are done accessing the bitmap's pixels, - * you must call Bitmap::Unlock to release the lock. + * you must call %Bitmap::Unlock() to release the lock. * * @since 2.0 * diff --git a/inc/FGrpCanvas.h b/inc/FGrpCanvas.h index 415cd47..0fa8c65 100644 --- a/inc/FGrpCanvas.h +++ b/inc/FGrpCanvas.h @@ -1136,7 +1136,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. - * @remarks BitmapPixelFormat::BITMAP_PIXEL_FORMAT_R8G8B8A8 is not applicable for this method. + * @remarks ::BITMAP_PIXEL_FORMAT_R8G8B8A8 is not applicable for this method. */ result DrawBitmap(const FloatRectangle& rect, const Bitmap& bitmap); @@ -1277,7 +1277,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @remarks ::BITMAP_PIXEL_FORMAT_R8G8B8A8 is not applicable for this method. - * This method faces a problem while working in an unbounded region and it affects the whole Canvas pixels in the case of ::COMPOSITE_MODE_SRC or ::COMPOSITE_MODE_CLEAR. + * This method faces a problem while working in an unbounded region and it affects the whole %Canvas pixels in the case of ::COMPOSITE_MODE_SRC or ::COMPOSITE_MODE_CLEAR. * @image html graphics_rotatebitmap.PNG */ result DrawBitmap(const FloatPoint& point, const Bitmap& bitmap, const FloatPoint& pivot, float degree); @@ -1472,8 +1472,8 @@ public: /** * Locks the %Canvas control for direct pixel access. @n * This sets up a %Canvas control for accessing the pixels directly. Between the calls to the - * Canvas::Lock() and Canvas::UnLock() methods, the data can be written to and read from the - * Canvas control's pixels. Once the operations on the %Canvas control's pixels are finished, the + * %Canvas::Lock() and Canvas::Unlock() methods, the data can be written to and read from the + * %Canvas control's pixels. Once the operations on the %Canvas control's pixels are finished, the * %Canvas::Unlock() method must be called to release the lock. * * @since 2.0 diff --git a/inc/FUiCtrlGroupedTableView.h b/inc/FUiCtrlGroupedTableView.h index 62b2049..4289b48 100644 --- a/inc/FUiCtrlGroupedTableView.h +++ b/inc/FUiCtrlGroupedTableView.h @@ -481,7 +481,8 @@ public: * * @since 2.0 * - * @return @c true if the group is expanded, else @c false + * @return @c true if the group is expanded, @n + * else @c false * @param[in] groupIndex The index of the group * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE A specified input parameter is invalid. @@ -504,7 +505,8 @@ public: * * @since 2.0 * - * @return @c true if the grouped look is enabled, else @c false + * @return @c true if the grouped look is enabled, @n + * else @c false */ bool IsGroupedLookEnabled(void) const; @@ -644,7 +646,8 @@ public: * * @since 2.0 * - * @return @c true if the collapse by pinch gesture is enabled, else @c false + * @return @c true if the collapse by pinch gesture is enabled, @n + * else @c false */ bool IsCollapseByPinchGestureEnabled(void) const; diff --git a/inc/FUiCtrlICustomElement.h b/inc/FUiCtrlICustomElement.h index 5197c13..2c84caf 100644 --- a/inc/FUiCtrlICustomElement.h +++ b/inc/FUiCtrlICustomElement.h @@ -70,7 +70,6 @@ public: * @param[in] canvas The graphic canvas of the list control * @param[in] rect The position and size of the element * @param[in] status The status of the element - * @remarks This method must return @c true if the drawing is successful, else @c false. */ virtual bool OnDraw(Tizen::Graphics::Canvas& canvas, const Tizen::Graphics::Rectangle& rect, Tizen::Ui::Controls::ListItemDrawingStatus status) = 0; diff --git a/inc/FUiCtrlICustomElementF.h b/inc/FUiCtrlICustomElementF.h index 04729ef..6267992 100644 --- a/inc/FUiCtrlICustomElementF.h +++ b/inc/FUiCtrlICustomElementF.h @@ -70,7 +70,6 @@ public: * @param[in] canvas The graphic canvas of the list control * @param[in] rect The position and size of the element * @param[in] status The status of the element - * @remarks This method must return @c true if the drawing is successful, else @c false. */ virtual bool OnDraw(Tizen::Graphics::Canvas& canvas, const Tizen::Graphics::FloatRectangle& rect, Tizen::Ui::Controls::ListItemDrawingStatus status) = 0; diff --git a/inc/FUiCtrlIGroupedListViewItemProvider.h b/inc/FUiCtrlIGroupedListViewItemProvider.h index 2384d2d..50bb770 100644 --- a/inc/FUiCtrlIGroupedListViewItemProvider.h +++ b/inc/FUiCtrlIGroupedListViewItemProvider.h @@ -160,7 +160,8 @@ public: * * @since 2.0 * - * @return @c true if the item can be reordered, else @c false + * @return @c true if the item can be reordered, @n + * else @c false * @param[in] groupIndexFrom The source group index of the item * @param[in] groupIndexTo The target group index of the item */ diff --git a/inc/FUiCtrlSectionTableView.h b/inc/FUiCtrlSectionTableView.h index fc55b3a..23fb73e 100644 --- a/inc/FUiCtrlSectionTableView.h +++ b/inc/FUiCtrlSectionTableView.h @@ -361,7 +361,8 @@ public: * * @since 2.0 * - * @return @c true if the grouped look is enabled, else @c false + * @return @c true if the grouped look is enabled, @n + * else @c false */ bool IsGroupedLookEnabled(void) const; -- 2.7.4