X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseColQueue.h;h=cafe6d1c05a0cf7279e68e20f1d8c118c2ce2470;hb=9646d95c0666d24d94fdefeedf94c951b9d6c812;hp=36b5d5db3cbb6ba7f7e687549047236158c67ea0;hpb=6b44196c40a66b895028f7ba2e9b5e41bc715ab2;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseColQueue.h b/inc/FBaseColQueue.h index 36b5d5d..cafe6d1 100644 --- 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 #include - 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 (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,10 +100,11 @@ 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. - * @remarks If the number of elements added to the queue reaches the current capacity, - * the capacity is automatically increased by memory reallocation. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - 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. @n * Therefore, if the size of the queue can be estimated, * specifying the initial capacity eliminates the need to perform a number of * resizing operations while adding elements to the queue. @@ -120,11 +119,12 @@ 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. - * @remarks This method performs a shallow copy. It copies just the pointer; not the element itself. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The @c collection is modified during the operation of this method. + * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself. * @see Queue() */ result Construct(const ICollection& collection); @@ -137,10 +137,11 @@ public: * @return The element at the beginning of this queue, @n * else @c null if this queue is empty * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * this queue is empty. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The queue is empty. * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Enqueue() + * @see Enqueue(Object*) */ virtual Object* Dequeue(void); @@ -149,16 +150,16 @@ public: * Inserts an object at the end of this queue. * * @brief [Deprecated] - * @deprecated This method is deprecated because it has a problem of const reference argument. + * @deprecated This method is deprecated because it has a problem of constant reference argument. * Instead of using this method, use Enqueue(Object* pObj). * @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() + * @remarks This method performs a shallow copy. It inserts just the pointer and not the element itself. + * @see Dequeue() * @endif */ result Enqueue(const Object& obj) @@ -172,43 +173,43 @@ 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 A pointer to the 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() + * @remarks This method performs a shallow copy. It inserts just the pointer and not the element itself. + * @see Dequeue() */ virtual result Enqueue(Object* pObj); /** - * Gets an enumerator of this queue. + * Gets the enumerator of this queue. * * @since 2.0 * - * @return An enumerator (an instance of the IEnumerator derived class) of this queue, @n + * @return The 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 */ virtual IEnumerator* GetEnumeratorN(void) const; /** - * Gets the element at the front of this queue without removing it. + * Gets the element at the beginning of this queue without removing it. * * @since 2.0 * * @return The element at the beginning of this queue, @n * else @c null if this queue is empty * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * this queue is empty. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The queue is empty. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual const Object* Peek(void) const; /** - * Removes all objects and their pointers in collection, when the @c deallocate parameter is set to @c true. - * + * Removes all the objects and their pointers from the 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 @@ -242,18 +243,19 @@ public: * Checks whether this queue contains all the elements in the specified collection. * * @brief [Deprecated] - * @deprecated This method is deprecated because it transfers a result of comparison in out-parameter form. - * The return type will be changed into boolean type and this method will return the result. + * @deprecated This method is deprecated because it transfers the result of the comparison in an out-parameter form. + * The return type is changed to boolean and this method returns the result. * Instead of using this method, use bool ContainsAll(const ICollection& collection). * @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 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 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 @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The @c collection is modified during the operation of this method. * @endif */ result ContainsAll(const ICollection& collection, bool& out) const @@ -269,11 +271,12 @@ 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. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The @c collection is modified during the operation of this method. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual bool ContainsAll(const ICollection& collection) const; @@ -286,8 +289,8 @@ public: * @return @c true if the specified instance equals the current instance, @n * else @c false * @param[in] obj The object to compare with the current instance - * @remarks This method returns @c true if and only if the specified object is also an instance of %Queue class, - * both queues have the same size, and all corresponding pairs of elements in the two queues are equal. + * @remarks This method returns @c true if and only if the specified object is also an instance of the %Queue class, + * both queues have the same size, and all the corresponding pairs of elements in the two queues are equal. @n * In other words, two queues are equal if they contain the same elements in the same order. */ virtual bool Equals(const Object& obj) const; @@ -298,8 +301,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const;