Apply header review on Gallery

Change-Id: Iee337cd2ba9111e6868e5f8e210b77d822623932
Signed-off-by: JongwooLee <jongwoo718.lee@samsung.com>

diff --git a/inc/FUiCtrlGallery.h b/inc/FUiCtrlGallery.h
index 78f8eeb..235b874 100644 (file)
--- a/inc/FUiCtrlGallery.h
+++ b/inc/FUiCtrlGallery.h
@@ -184,7 +184,8 @@ class _OSP_EXPORT_ Gallery
 {
 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
         */
@@ -205,8 +206,8 @@ public:
         *
         * @return              An error code
         * @param[in]   rect            An instance of the Graphics::Rectangle class @n
-        *                                                              This instance represents the x and y coordinates of the top-left corner of the created %Gallery control along with the
-        *                                                                      width and height.
+        *                                      This instance represents the x and y coordinates of the top-left corner of the created %Gallery control along with the
+        *                                      width and height.
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG   The specified input parameter is invalid.
         * @exception   E_SYSTEM                        A system error has occurred.
@@ -219,9 +220,9 @@ public:
         * @since               2.1
         *
         * @return              An error code
-        * @param[in]   rect            An instance of the Graphics::FloatRectangle class @n
-        *                                                              This instance represents the x and y coordinates of the top-left corner of the created %Gallery control along with the
-        *                                                                      width and height.
+        * @param[in]   rect            An instance of the Tizen::Graphics::FloatRectangle class @n
+        *                                      This instance represents the x and y coordinates of the top-left corner of the created %Gallery control along with the
+        *                                      width and height.
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG   The specified input parameter is invalid.
         * @exception   E_SYSTEM                        A system error has occurred.
@@ -247,7 +248,7 @@ public:
         *
         * @since               2.0
         *
-        * @param[in]   listener                The listener to be added
+        * @param[in]   listener                The listener to add
         */
        void AddGalleryEventListener(IGalleryEventListener& listener);
 
@@ -257,7 +258,7 @@ public:
         *
         * @since               2.0
         *
-        * @param[in]   listener                The listener to be removed
+        * @param[in]   listener                The listener to remove
         */
        void RemoveGalleryEventListener(IGalleryEventListener& listener);
 
@@ -301,7 +302,7 @@ public:
         * @since               2.0
         *
         * @return              An error code
-        * @param[in]   itemIndex                       The index of the item to be refreshed
+        * @param[in]   itemIndex                       The index of the item to refresh
         * @param[in]   type                    The type of change for an item
         * @exception   E_SUCCESS                               The method is successful.
         * @exception   E_OUT_OF_RANGE  The specified @c index is out of range.
@@ -355,9 +356,11 @@ public:
         * @param[in]   pBitmap                         The bitmap of the empty %Gallery control
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_SYSTEM                        A system error has occurred.
-        * @remarks             When @c pBitmap is @c null, the %Gallery control does not have a background bitmap. The default value for the background bitmap is @c null.
-        * @remarks             The background bitmap has a priority over the background color. When both the background bitmap and the background color are specified,
-        *                              only the bitmap is displayed.
+        * @remarks
+        *                              - When @c pBitmap is @c null, the %Gallery control does not have a background bitmap. @n
+        *                              The default value for the background bitmap is @c null.
+        *                              - The background bitmap has a priority over the background color. When both the background bitmap and 
+        *                              the background color are specified, only the bitmap is displayed.
         */
        result SetBitmapOfEmptyGallery(const Tizen::Graphics::Bitmap* pBitmap);
 
@@ -383,8 +386,9 @@ public:
         * @exception E_SUCCESS                The method is successful.
         * @exception E_UNSUPPORTED_OPERATION  This operation is not supported.
         * @exception E_SYSTEM                 A system error has occurred.
-        * @remarks   The specific error code can be accessed using the GetLastResult() method.
-        * @remarks   The method is not supported in 16-bit devices.
+        * @remarks
+        *                              - The specific error code can be accessed using the GetLastResult() method.
+        *                              - The method is not supported in 16-bit devices.
         */
        GalleryAnimation GetSlideShowAnimation(void) const;
 
@@ -396,10 +400,11 @@ public:
         * @param[in]   duration        The animation duration
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_OUT_OF_RANGE          The specified @c duration is out of the possible duration range. @n
-        *                              The specified duration should be greater than or equal to 300 or less than or equals to 20000.
+        *                                                                      The specified duration should be greater than or equal to 300 or less than or equals to @c 20000.
         * @exception   E_SYSTEM                        A system error has occurred.
-        * @remarks     The unit of the duration is in milliseconds.@n
-        *                              The default animation duration is different for each slide show animation type.
+        * @remarks
+        *                              - The unit of the duration is in milliseconds.
+        *                              - The default animation duration is different for each slide show animation type.
         */
        result SetSlideShowAnimationDuration(int duration);
 
@@ -424,10 +429,11 @@ public:
         * @param[in]   duration                The item view duration
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_OUT_OF_RANGE  The specified @c duration is out of possible duration range. @n
-        *                                                              - The specified @c duration should be greater than 10.
+        *                                                              - The specified @c duration should be greater than @c 10.
         * @exception   E_SYSTEM                        A system error has occurred.
-        * @remarks     The unit of the duration is in milliseconds.@n
-        *                              The default animation duration is different for each slide show animation type.
+        * @remarks
+        *                              - The unit of the duration is in milliseconds.
+        *                              - The default animation duration is different for each slide show animation type.
         */
        result SetSlideShowViewDuration(int duration);
 
@@ -518,7 +524,7 @@ public:
         * @param[in]   color   The background color
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_SYSTEM                A system error has occurred.
-        * @remarks     The method ignores the alpha value of the @c color parameter and sets the alpha value to 255.
+        * @remarks     The method ignores the alpha value of the @c color parameter and sets the alpha value to @c 255.
         */
        result SetBackgroundColor(const Tizen::Graphics::Color& color);
 

diff --git a/inc/FUiCtrlGalleryItem.h b/inc/FUiCtrlGalleryItem.h
index b0b0032..3282326 100644 (file)
--- a/inc/FUiCtrlGalleryItem.h
+++ b/inc/FUiCtrlGalleryItem.h
@@ -51,7 +51,8 @@ class _OSP_EXPORT_ GalleryItem
 {
 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
         */

diff --git a/inc/FUiCtrlIGalleryEventListener.h b/inc/FUiCtrlIGalleryEventListener.h
index d06b60c..84c9da9 100644 (file)
--- a/inc/FUiCtrlIGalleryEventListener.h
+++ b/inc/FUiCtrlIGalleryEventListener.h
@@ -53,7 +53,8 @@ class _OSP_EXPORT_ IGalleryEventListener
 {
 public:
        /**
-        * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+        * This polymorphic destructor should be overridden if required.@n
+        * This way, the destructors of the derived classes are called when the destructor of this interface is called.
         *
         * @since 2.0
         */

diff --git a/inc/FUiCtrlIGalleryItemProvider.h b/inc/FUiCtrlIGalleryItemProvider.h
index 07c9415..e45ec92 100644 (file)
--- a/inc/FUiCtrlIGalleryItemProvider.h
+++ b/inc/FUiCtrlIGalleryItemProvider.h
@@ -46,7 +46,8 @@ class _OSP_EXPORT_ IGalleryItemProvider
 {
 public:
        /**
-        * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+        * This polymorphic destructor should be overridden if required.@n
+        * This way, the destructors of the derived classes are called when the destructor of this interface is called.
         *
         * @since       2.0
         */