X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseColStack.h;h=8b74c097273793ab0cca077a622be5c6fe7daaf6;hb=ebb2ea372f640b8fe09dc5a85abb29bb349508fa;hp=15fb460088202cb4c4f930afabdd2de66fa39469;hpb=00cb5b2e80a311e328d0a7870e5292727429d371;p=platform%2Fframework%2Fnative%2Fappfw.git
diff --git a/inc/FBaseColStack.h b/inc/FBaseColStack.h
index 15fb460..8b74c09 100644
--- a/inc/FBaseColStack.h
+++ b/inc/FBaseColStack.h
@@ -103,9 +103,10 @@ 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.
- * @remarks If the number of elements added to the stack reaches the current capacity,
+ * @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 stack reaches the current capacity,
* the capacity is automatically increased by memory reallocation. @n
* Therefore, if the size of the stack can be estimated,
* specifying the initial capacity eliminates the need to perform a number of
@@ -123,22 +124,22 @@ 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 @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 specified @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 Stack()
*/
result Construct(const ICollection& collection);
/**
- * Gets an enumerator of this stack.
+ * Gets the enumerator of this stack.
*
* @since 2.0
*
- * @return An enumerator (an instance of the IEnumerator derived class) of this stack, @n
+ * @return The enumerator (an instance of the IEnumerator derived class) of this stack, @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;
@@ -150,8 +151,9 @@ public:
* @return The element at the top of this stack, @n
* else @c null if this stack is empty
* @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.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual const Object* Peek(void) const;
@@ -164,8 +166,9 @@ public:
* @return The element at the top of this stack, @n
* else @c null if this stack is empty
* @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.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Push(Object*)
*/
@@ -176,7 +179,7 @@ public:
* Pushes an object to the top of this stack.
*
* @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 Push(Object* pObj).
* @since 2.0
*
@@ -184,7 +187,7 @@ public:
* @param[in] obj The object to add to this stack
* @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.
+ * @remarks This method performs a shallow copy. It inserts just the pointer and not the element itself.
* @see Pop()
* @endif
*/
@@ -199,16 +202,16 @@ public:
* @since 2.0
*
* @return An error code
- * @param[in] pObj The pointer to object to add to this stack
+ * @param[in] pObj A pointer to the object to add to this stack
* @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.
+ * @remarks This method performs a shallow copy. It inserts just the pointer and not the element itself.
* @see Pop()
*/
virtual result Push(Object* pObj);
/**
- * Removes all objects and their pointers in collection, when the @c deallocate parameter is set to @c true. @n
+ * Removes all the objects and their pointers from the collection, when the @c deallocate parameter is set to @c true. @n
* This method can be called before deleting the objects in a collection.
*
* @since 2.0
@@ -243,18 +246,19 @@ public:
* Checks whether this stack contains all of 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 Contains(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 stack 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 stack 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 specified @c collection is modified during the operation of this method.
* @endif
*/
result ContainsAll(const ICollection& collection, bool& out) const
@@ -265,7 +269,7 @@ public:
}
/**
- * Checks whether this stack contains all of the elements in the specified collection.
+ * Checks whether this stack contains all the elements in the specified collection.
*
* @since 2.0
*
@@ -273,8 +277,9 @@ public:
* 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 specified @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,9 +291,9 @@ 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 only if the specified object is also an instance of %Stack class,
- * both stacks have the same size, and all corresponding pairs of elements in the two stacks are equal.
+ * @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 the 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;
@@ -299,8 +304,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;