[2.2.1] Update examples and doxygen comments of RegularExpression

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

diff --git a/inc/FBaseColQueue.h b/inc/FBaseColQueue.h
index 36b5d5d..83f353a 100644 (file)
--- a/inc/FBaseColQueue.h
+++ b/inc/FBaseColQueue.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 <FBaseTypes.h>
 #include <FBaseColICollection.h>
 
-
 namespace Tizen { namespace Base { namespace Collection
 {
 /**
@@ -64,7 +62,7 @@ namespace Tizen { namespace Base { namespace Collection
  *             const Object* pObj = queue.Peek();              // pObj: "First", queue.GetCount(): 3
  *
  *             // Reads and removes the element at the beginning
- *             String* pStr = static_cast<String*> (queue.Dequeue());  // pStr: "First", queue.GetCount(): 2
+ *             String* pStr = static_cast< String* > (queue.Dequeue());        // pStr: "First", queue.GetCount(): 2
  *
  *             delete pStr;     // Because the queue does not have the Ownership of this pStr after dequeueing
  *
@@ -102,8 +100,8 @@ public:
         * @param[in]   capacity                        The number of elements in the queue @n
         *                                                                      The default capacity is @c 10.
         * @exception   E_SUCCESS                       The method is successful.
-        * @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.
         * @remarks             If the number of elements added to the queue reaches the current capacity,
         *                              the capacity is automatically increased by memory reallocation.
         *                              Therefore, if the size of the queue can be estimated,
@@ -120,7 +118,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   collection The collection to copy elements from
+        * @param[in]   collection                      The collection to copy elements from
         * @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 @c collection is modified during the operation of this method.
@@ -140,7 +138,7 @@ public:
         * @exception   E_UNDERFLOW     The operation (arithmetic/casting/conversion) has caused an underflow, or
         *                                                      this queue is empty.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
-        * @see                         Enqueue()
+        * @see                 Enqueue(Object*)
         */
        virtual Object* Dequeue(void);
 
@@ -154,11 +152,11 @@ public:
         * @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.
         * @remarks             This method performs a shallow copy. It inserts just the pointer; not the element itself.
-        * @see                         Dequeue()
+        * @see                 Dequeue()
         * @endif
         */
        result Enqueue(const Object& obj)
@@ -172,11 +170,11 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   pObj            The pointer to object to add to this queue
-        * @exception   E_SUCCESS               The method is successful.
+        * @param[in]   pObj                            The pointer to object to add to this queue
+        * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG           The specified input parameter is invalid.
         * @remarks             This method performs a shallow copy. It inserts just the pointer; not the element itself.
-        * @see                         Dequeue()
+        * @see                 Dequeue()
         */
        virtual result Enqueue(Object* pObj);
 
@@ -188,7 +186,7 @@ public:
         * @return              An enumerator (an instance of the IEnumerator derived class) of this queue, @n
         *                              else @c null if an exception occurs
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
-        * @see                         IEnumerator
+        * @see                 IEnumerator
         */
        virtual IEnumerator* GetEnumeratorN(void) const;
 
@@ -208,7 +206,7 @@ public:
 
        /**
         * Removes all objects and their pointers in collection, when the @c deallocate parameter is set to @c true.
-        * 
+        *
         * @since 2.0
         *
         * @param[in]   deallocate              Set to @c true to deallocate all objects, @n
@@ -269,8 +267,8 @@ public:
         * @since 2.0
         *
         * @return              @c true if this queue contains all the elements in the specified collection, @n
-        *                                      else @c false
-        * @param[in]   collection      The collection to locate
+        *                              else @c false
+        * @param[in]   collection                      The collection to locate
         * @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 @c collection is modified during the operation of this method.