X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseColStackT.h;h=47500963722621042aff4c7c5f59bec7ed75540e;hb=60d143778a54ae4c638a08d8c7304b099f70434e;hp=fe62e833526ea5cffd7f7e89ab32c658e9fdb91f;hpb=3b569ff3e66a065cb5728bc19d1da493c66f7583;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseColStackT.h b/inc/FBaseColStackT.h index fe62e83..4750096 100644 --- a/inc/FBaseColStackT.h +++ b/inc/FBaseColStackT.h @@ -114,8 +114,9 @@ public: * @param[in] capacity The number of elements @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 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) { @@ -140,8 +141,9 @@ public: * @return An error code * @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 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. * @see StackT() */ result Construct(const ICollectionT< Type >& collection) @@ -193,16 +195,15 @@ CATCH: } /** - * Gets an enumerator of this stack. + * Gets the enumerator of this stack. * * @since 2.0 * - * @return An enumerator (an instance of the IEnumeratorT derived class) of this stack, @n + * @return The enumerator (an instance of the IEnumeratorT derived class) of this stack, @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 { @@ -228,8 +229,9 @@ CATCH: * @return An error code * @param[out] obj The element at the beginning of this stack * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * this stack is empty. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The stack is empty. */ virtual result Peek(Type& obj) const { @@ -251,8 +253,9 @@ CATCH: * @return An error code * @param[out] obj The element at the beginning of this stack * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * this stack is empty. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The stack is empty. * @see Push() */ virtual result Pop(Type& obj) @@ -272,7 +275,7 @@ CATCH: } /** - * Pushes an object at the top of this stack. + * Pushes an object to the top of this stack. * * @since 2.0 * @@ -317,7 +320,7 @@ CATCH: } /** - * Removes all elements in this stack. + * Removes all the elements from this stack. * * @since 2.0 */ @@ -376,17 +379,17 @@ CATCH: } /** - * Checks whether this stack contains all of the elements in the specified @c collection. + * Checks whether this stack contains all the elements in the specified @c collection. * * @since 2.0 * * @return An error code - * @param[in] collection The collection to locate - * @param[out] out Set to @c true if this stack contains all of the elements in the specified @c collection, @n - * else @c false + * @param[in] collection The collection to locate + * @param[out] out The boolean value that indicates if this stack contains all the elements in the specified @c collection * @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. */ virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const { @@ -442,8 +445,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 only if the specified object is also an instance of the Stack class, - * both stacks have the same size, and all the corresponding pairs of elements in the two stacks are equal. + * @remarks This method returns @c true only if the specified object is also an instance of the Stack class, + * both the stacks have the same size, and all the corresponding pairs of elements in the two stacks are equal. @n * In other words, two stacks are equal if they contain the same elements in the same order. */ virtual bool Equals(const Object& obj) const @@ -485,8 +488,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 { @@ -569,10 +572,10 @@ public: * * @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 + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. * - This enumerator is currently positioned before the first element or - * past the last element. @n + * past the last element. * - The stack is modified after this enumerator is created. * @exception E_SUCCESS The method is successful. */