Added ImmutableString class to appfw

[platform/framework/native/appfw.git] / inc / FBaseColQueueT.h

diff --git a/inc/FBaseColQueueT.h b/inc/FBaseColQueueT.h
index 62a94c4..42bfe86 100644 (file)
--- a/inc/FBaseColQueueT.h
+++ b/inc/FBaseColQueueT.h
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -29,7 +28,6 @@
 #include <FBaseResult.h>
 #include <FBaseColICollectionT.h>
 
-
 namespace Tizen { namespace Base { namespace Collection
 {
 
@@ -118,8 +116,8 @@ public:
         *                                  The default capacity is @c 10.
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_OUT_OF_MEMORY         The memory is insufficient.
-        * @exception   E_INVALID_ARG   The specified input parameter is invalid, or
-        *                                                                the specified @c capacity is negative.
+        * @exception   E_INVALID_ARG           The specified input parameter is invalid, or
+        *                                                                      the specified @c capacity is negative.
         */
        result Construct(int capacity = DEFAULT_CAPACITY)
        {
@@ -142,7 +140,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   collection The collection to copy the elements from
+        * @param[in]   collection                      The collection to copy the elements from
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_OUT_OF_MEMORY         The memory is insufficient.
         * @exception   E_INVALID_OPERATION     The current state of the instance prohibits the execution of the specified operation, or
@@ -202,7 +200,7 @@ CATCH:
         * @since 2.0
         *
         * @return              An error code
-        * @param[out]  obj The element at the beginning of this queue
+        * @param[out]  obj                     The element at the beginning of this queue
         * @exception   E_SUCCESS       The method is successful.
         * @exception   E_UNDERFLOW     The operation (arithmetic/casting/conversion) has caused an underflow, or
         *                                                      this queue is empty.
@@ -228,7 +226,7 @@ CATCH:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   obj The object to add to this queue
+        * @param[in]   obj                             The object to add to this queue
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_OUT_OF_MEMORY The memory is insufficient.
         * @see                 Dequeue()
@@ -319,7 +317,7 @@ CATCH:
         * @since 2.0
         *
         * @return              An error code
-        * @param[out]  obj The element at the beginning of this queue
+        * @param[out]  obj                     The element at the beginning of this queue
         * @exception   E_SUCCESS       The method is successful.
         * @exception   E_UNDERFLOW     The operation (arithmetic/casting/conversion) has caused an underflow, or
         *                                                      this queue is empty.
@@ -378,9 +376,9 @@ CATCH:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   collection      The collection to locate
-        * @param[out]  out  Set to @c true if this queue contains all of the elements in the specified collection, @n
-        *                                       else @c false
+        * @param[in]   collection                      The collection to locate
+        * @param[out]  out                                     Set to @c true if this queue contains all of the elements in the specified collection, @n
+        *                                                                      else @c false
         * @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.
@@ -565,13 +563,13 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[out]  obj The current object
-        * @exception   E_INVALID_OPERATION       Either of the following conditions has occurred: @n
-        *                                                                      - The current state of the instance prohibits the execution of the specified operation. @n
-        *                                                                      - This enumerator is currently positioned before the first element or
-        *                                                                      past the last element. @n
-        *                                                                      - The queue is modified after this enumerator is created.
-        * @exception   E_SUCCESS                       The method is successful.
+        * @param[out]  obj                                     The current object
+        * @exception   E_INVALID_OPERATION             Either of the following conditions has occurred: @n
+        *                                                                              - The current state of the instance prohibits the execution of the specified operation. @n
+        *                                                                              - This enumerator is currently positioned before the first element or
+        *                                                                              past the last element. @n
+        *                                                                              - The queue is modified after this enumerator is created.
+        * @exception   E_SUCCESS                               The method is successful.
         */
        result GetCurrent(Type& obj) const
        {