Add privilege check code.
[platform/framework/native/appfw.git] / inc / FBaseColIListT.h
index 6c857ea..b0109fd 100644 (file)
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
 #include <FBaseColICollectionT.h>
 #include <FBaseColIComparerT.h>
 
-
 namespace Tizen { namespace Base { namespace Collection
 {
 
 /**
- * @interface IListT
- * @brief This interface represents a template-based collection of objects that can be individually accessed by an index.
+ * @interface  IListT
+ * @brief              This interface represents a template-based collection of objects that can be individually accessed by an index.
  *
  * @since 2.0
  *
@@ -60,7 +58,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   obj     The object to add
+        * @param[in]   obj                             The object to add
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_OUT_OF_MEMORY The memory is insufficient.
         * @remarks             In a collection of contiguous elements, such as a list, the elements
@@ -78,7 +76,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   collection The collection to add
+        * @param[in]   collection                      The collection to add
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_OPERATION     The current state of the instance prohibits the execution of the specified operation, or
         *                                                                      the specified @c collection is modified during the operation of this method.
@@ -201,7 +199,7 @@ public:
         *
         * @return              An error code
         * @param[in]   index   The index of the object to get
-        * @param[out]  obj     The object obtained from the list
+        * @param[out]  obj             The object obtained from the list
         * @exception   E_SUCCESS                               The method is successful.
         * @exception   E_OUT_OF_RANGE                  The specified index is outside the bounds of the data structure, or
         *                                                                              the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
@@ -216,7 +214,7 @@ public:
         *
         * @return              An error code
         * @param[in]   index   The index of the object to get
-        * @param[out]  obj     The object obtained from the list
+        * @param[out]  obj             The object obtained from the list
         * @exception   E_SUCCESS                               The method is successful.
         * @exception   E_OUT_OF_RANGE                  The specified index is outside the bounds of the data structure, or
         *                                                                              the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
@@ -249,7 +247,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   obj     The object to remove
+        * @param[in]   obj                                     The object to remove
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_OBJ_NOT_FOUND         The object is not found.
         */
@@ -261,7 +259,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   index The index at which the object must be removed
+        * @param[in]   index                                   The index at which the object must be removed
         * @exception   E_SUCCESS                               The method is successful.
         * @exception   E_OUT_OF_RANGE                  The specified index is outside the bounds of the data structure, or
         *                                                                              the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
@@ -274,7 +272,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   collection The collection to remove from this list
+        * @param[in]   collection                      The collection to remove from this list
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_OPERATION     The current state of the instance prohibits the execution of the specified operation, or
         *                                                                      the specified @c collection is modified during the operation of this method.
@@ -315,7 +313,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   obj     The new object
+        * @param[in]   obj             The new object
         * @param[in]   index   The index at which the new object must be set
         * @exception   E_SUCCESS                               The method is successful.
         * @exception   E_OUT_OF_RANGE                  The specified index is outside the bounds of the data structure, or
@@ -330,8 +328,8 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   comparer        The IComparerT implementation to use when comparing elements
-        * @exception   E_SUCCESS                       The method is successful.
+        * @param[in]   comparer                The IComparerT implementation to use when comparing elements
+        * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG   The specified input parameter is invalid.
         */
        virtual result Sort(const IComparerT< Type >& comparer) = 0;
@@ -369,14 +367,14 @@ public:
         *
         * @since 2.0
         *
-        * @return        A pointer to a bidirectional enumerator interface of the %IListT derived class, @n
-        *                              else @c null if an exception occurs
-        * @exception    E_SUCCESS        The method is successful.
-        * @exception    E_OUT_OF_MEMORY         The memory is insufficient.
-        * @remarks      Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class)
-        *                              to iterate over a collection (an instance of the %IListT derived class).
-        * @remarks      The specific error code can be accessed using the GetLastResult() method.
-        * @see           Tizen::Base::Collection::IBidirectionalEnumeratorT
+        * @return              A pointer to a bidirectional enumerator interface of the %IListT derived class, @n
+        *                              else @c null if an exception occurs
+        * @exception   E_SUCCESS                       The method is successful.
+        * @exception   E_OUT_OF_MEMORY         The memory is insufficient.
+        * @remarks             Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class)
+        *                              to iterate over a collection (an instance of the %IListT derived class).
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.
+        * @see                 Tizen::Base::Collection::IBidirectionalEnumeratorT
         */
        virtual IBidirectionalEnumeratorT< Type >* GetBidirectionalEnumeratorN(void) const = 0;