Modification based on magnolia/doc/sdk-internal
authorsriram.k <sriram.k@samsung.com>
Mon, 22 Apr 2013 09:07:07 +0000 (14:37 +0530)
committersriram.k <sriram.k@samsung.com>
Mon, 22 Apr 2013 09:07:07 +0000 (14:37 +0530)
Signed-off-by: sriram.k <sriram.k@samsung.com>
Change-Id: I414bebd0941265f599c94846b2285aae480f84b5

inc/FUiCtrlIconList.h

index e343690..dac2e29 100644 (file)
@@ -186,7 +186,8 @@ class _OSP_EXPORT_ IconList
 public:
        /**
         * @if OSPDEPREC
-        * 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 IconList::Construct() method must be called right after calling this constructor.
         *
         * @brief       <i> [Deprecated] </i>
         * @deprecated  This class is deprecated. Instead of using this class, use the IconListView class.
@@ -197,7 +198,8 @@ public:
 
        /**
         * @if OSPDEPREC
-        * 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.
         *
         * @brief       <i> [Deprecated] </i>
         * @deprecated  This class is deprecated. Instead of using this class, use the IconListView class.
@@ -225,10 +227,11 @@ public:
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG   A specified input parameter is invalid.
         * @exception   E_SYSTEM                A system error has occurred.
-        * @remarks             A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
-        * @remarks             The %IconList cannot display more than 64 items on screen at once.
-        * @remarks             The size of the control must be within the range defined by the minimum and maximum size.
-        * @remarks             The minimum size of this control is 0 x 0.
+        * @remarks             
+        *                              - A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
+        *                              - The %IconList cannot display more than 64 items on screen at once.
+        *                              - The size of the control must be within the range defined by the minimum and maximum size.
+        *                              - The minimum size of this control is 0 x 0.
         * @endif
         */
        result Construct(const Tizen::Graphics::Rectangle& rect, IconListStyle style, int itemWidth, int itemHeight);
@@ -336,8 +339,9 @@ public:
         * @param[in]   itemId              The item ID
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_SYSTEM                A system error has occurred.
-        * @remarks         The contents of the specified texts and bitmaps are copied and kept by %List.
-        *                              To display text in multi-lines or to denote the end of line, use '\\n'.
+        * @remarks         
+        *                              - The contents of the specified texts and bitmaps are copied and kept by %List.
+        *                              - To display text in multi-lines or to denote the end of line, use '\\n'.
         * @endif
         */
        result AddItem(const Tizen::Base::String* pText, const Tizen::Graphics::Bitmap* pNormalBitmap, const Tizen::Graphics::Bitmap* pFocusedBitmap, int itemId = LIST_ITEM_UNSPECIFIED_ID);
@@ -359,8 +363,9 @@ public:
         * @param[in]   itemId                  The item ID
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_SYSTEM                A system error has occurred.
-        * @remarks             The contents of the specified texts and bitmaps are copied and kept by %IconList.
-        *                              To display text in multi-lines or to denote the end of line, use '\\n'.
+        * @remarks             
+        *                              - The contents of the specified texts and bitmaps are copied and kept by %IconList.
+        *                              - To display text in multi-lines or to denote the end of line, use '\\n'.
         * @endif
         */
        result InsertItemAt(int index, const Tizen::Base::String* pText, const Tizen::Graphics::Bitmap* pNormalBitmap, const Tizen::Graphics::Bitmap* pFocusedBitmap, int itemId = LIST_ITEM_UNSPECIFIED_ID);
@@ -382,9 +387,10 @@ public:
         * @param[in]   itemId              The item ID
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_SYSTEM                A system error has occurred.
-        * @remarks             The contents of the specified texts and bitmaps are copied and kept by %IconList.
+        * @remarks             
+        *                              - The contents of the specified texts and bitmaps are copied and kept by %IconList.
         *                          Call RefreshItem() to update item images.
-        *                              To display text in multi-lines or to denote the end of line, use '\\n'.
+        *                              To display text in multi-lines or to denote the end of line, use '\\n'.
         * @endif
         */
        result SetItemAt(int index, const Tizen::Base::String* pText, const Tizen::Graphics::Bitmap* pNormalBitmap, const Tizen::Graphics::Bitmap* pFocusedBitmap, int itemId = LIST_ITEM_UNSPECIFIED_ID);