X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseColQueueT.h;h=a9929a857f7dba81fc84bfcee0d4543840e93a62;hb=b54953ec1a6df32b1f10ce54ec189c9a3ad826b0;hp=42bfe86ac9b57c160f6137ee8a3786b35eb2c6ef;hpb=01cbd4ce082a67f98ea0c0dd2a440f570e87185f;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseColQueueT.h b/inc/FBaseColQueueT.h index 42bfe86..a9929a8 100644 --- a/inc/FBaseColQueueT.h +++ b/inc/FBaseColQueueT.h @@ -35,7 +35,7 @@ template< class Type > class __QueueEnumeratorT; /** * @class QueueT - * @brief This represents a template-based queue (a first-in-first-out collection of objects). + * @brief This class represents a template-based queue (a first-in-first-out collection of objects). * * @since 2.0 * @@ -116,8 +116,9 @@ 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 Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c capacity is negative. */ result Construct(int capacity = DEFAULT_CAPACITY) { @@ -143,8 +144,9 @@ public: * @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 - * 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 specified @c collection is modified during the operation of this method. * @see QueueT() */ result Construct(const ICollectionT< Type >& collection) @@ -202,8 +204,9 @@ CATCH: * @return An error code * @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. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The queue is empty. * @see Enqueue() */ virtual result Dequeue(Type& obj) @@ -264,7 +267,7 @@ CATCH: } /** - * Removes all the elements in this queue. + * Removes all the elements from this queue. * * @since 2.0 */ @@ -284,16 +287,15 @@ CATCH: } /** - * Gets an enumerator of this queue. + * Gets the enumerator of this queue. * * @since 2.0 * - * @return An enumerator (an instance of the IEnumeratorT derived class) of this queue, @n + * @return The enumerator (an instance of the IEnumeratorT derived class) of this queue, @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 The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IEnumeratorT */ virtual IEnumeratorT< Type >* GetEnumeratorN(void) const { @@ -319,8 +321,9 @@ CATCH: * @return An error code * @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. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The queue is empty. */ virtual result Peek(Type& obj) const { @@ -380,8 +383,9 @@ CATCH: * @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. + * @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 specified @c collection is modified during the operation of this method. * @exception E_OUT_OF_MEMORY The memory is insufficient. */ virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const @@ -437,8 +441,8 @@ CATCH: * @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 %QueueT 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 %QueueT 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 @@ -479,8 +483,8 @@ CATCH: * @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 { @@ -538,7 +542,7 @@ public: * * @since 2.0 * - * @param[in] queue A queue to enumerate + * @param[in] queue The queue to enumerate * @param[in] modeCount The modification count to detect the change in the queue */ __QueueEnumeratorT(const QueueT< Type >& queue, int modeCount) @@ -564,10 +568,10 @@ public: * * @return An error code * @param[out] obj The current object - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: * - 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 + * past the last element. * - The queue is modified after this enumerator is created. * @exception E_SUCCESS The method is successful. */ @@ -592,8 +596,9 @@ public: * * @return An error code * @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 queue is modified after this enumerator is created. + * @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 queue is modified after this enumerator is created. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the queue. * @see Reset() */ @@ -628,8 +633,9 @@ public: * * @return An error code * @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 queue is modified after this enumerator is created. + * @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 queue is modified after this enumerator is created. */ result Reset(void) {