From: dahyeong.kim Date: Thu, 24 Oct 2013 07:07:15 +0000 (+0900) Subject: [2.2.1] Apply reviewed header file (Base to Collection) X-Git-Tag: submit/tizen/20131210.080830^2^2~29^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=60d143778a54ae4c638a08d8c7304b099f70434e;hp=3b569ff3e66a065cb5728bc19d1da493c66f7583;p=platform%2Fframework%2Fnative%2Fappfw.git [2.2.1] Apply reviewed header file (Base to Collection) Change-Id: I871d562827e10e6595b3ada55cd929ca25b39b33 Signed-off-by: dahyeong.kim --- diff --git a/inc/FBase.h b/inc/FBase.h index 98e5852..0918b77 100644 --- a/inc/FBase.h +++ b/inc/FBase.h @@ -15,8 +15,8 @@ // /** - * @file FBase.h - * @brief This is the header file for the %Base namespace. + * @file FBase.h + * @brief This is the header file for the %Base namespace. * * This header file contains the declarations and descriptions of the %Base namespace. */ @@ -73,15 +73,15 @@ * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * * The %Base namespace contains classes and interfaces around which the entire %Tizen platform is built. * The main features of the namespace include basic data types, collections, runtime libraries, and various utilities. * * For more information on the %Base namespace features, see Base Guide. * - * The following diagram illustrates the relationships between the classes belonging to the %Base namespace. - * @image html base_namespace_classdiagram.png + * The following diagram illustrates the relationships between the classes belonging to the %Base namespace. + * @image html base_namespace_classdiagram.png * * * diff --git a/inc/FBaseBoolean.h b/inc/FBaseBoolean.h index 7c51f03..7a40c06 100644 --- a/inc/FBaseBoolean.h +++ b/inc/FBaseBoolean.h @@ -35,7 +35,7 @@ namespace Tizen { namespace Base * * @since 2.0 * - * The %Boolean class wraps a bool type value. This enables passing a bool value to a method that only accepts an instance of the Object class. + * The %Boolean class wraps a boolean type value. This enables passing a boolean value to a method that only accepts an instance of the Object class. * It provides methods to convert %Boolean instances to String and %String instances to %Boolean. * * The following example demonstrates how to use the %Boolean class. @@ -68,11 +68,11 @@ class _OSP_EXPORT_ Boolean { public: /** - * Initializes this instance of the %Boolean class with the specified @c value. + * Initializes this instance of %Boolean with the specified @c value. * * @since 2.0 * - * @param[in] value The input @c bool value to initialize the %Boolean instance + * @param[in] value The @c bool value used to initialize %Boolean */ Boolean(bool value); @@ -81,14 +81,14 @@ public: * * @since 2.0 * - * @param[in] value An instance of the %Boolean class + * @param[in] value An instance of %Boolean */ Boolean(const Boolean& value); /** * Initializes this instance of %Boolean with the specified input string. @n - * If the input is "true" (ignoring case), the object is initialized to @c true, - * else @c false. + * If the input is "true" (ignoring cases), the object is initialized to @c true, + * otherwise to @c false. * * @since 2.0 * @@ -108,8 +108,8 @@ public: * * @since 2.0 * - * @return @c true if the values of the objects are equal, @n - * else @c false. + * @return @c true if the values of the objects are equal, @n + * else @c false * @param[in] rhs An instance of %Boolean to compare with the current instance */ bool operator ==(const Boolean& rhs) const; @@ -119,7 +119,7 @@ public: * * @since 2.0 * - * @return @c true if the values of the objects are not equal, @n + * @return @c true if the values of the objects are not equal, @n * else @c false * @param[in] rhs An instance of %Boolean to compare with the current instance */ @@ -135,14 +135,13 @@ public: Boolean& operator =(const Boolean& rhs); /** - * Converts an instance of the Object class to an instance of %Boolean and then - * compares it with the calling %Boolean instance. + * Compares the specified Object instance with the current %Boolean instance. * * @since 2.0 * - * @return @c true if the value of @c obj matches the value of the calling %Boolean instance, @n + * @return @c true if @c obj matches the current %Boolean instance, @n * else @c false - * @param[in] obj A reference to the Object instance to compare with the calling %Boolean instance + * @param[in] obj A reference to the Object instance to compare with the current %Boolean instance * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Object& obj) const; @@ -152,30 +151,30 @@ 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. + * @return The hash value of the current instance + * @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; /** - * Converts a bool value to an instance of %Boolean and then - * compares it with the calling %Boolean instance. + * Converts a @c bool value to an instance of %Boolean and then + * compares it with the current %Boolean instance. * * @since 2.0 * - * @return @c true if the parameter matches the calling %Boolean instance, @n + * @return @c true if @c value matches the current %Boolean instance, @n * else @c false * @param[in] value The @c bool value to compare to this instance */ bool Equals(bool value) const; /** - * Returns the value of the calling object as @c bool. + * Returns the value of the current object as @c bool. * * @since 2.0 * - * @return The value of the %Boolean instance as bool + * @return The value of the %Boolean instance as @c bool */ bool ToBool(void) const; @@ -185,10 +184,9 @@ public: * @since 2.0 * * @return @c true if the value of the specified string is "true", @n - * else @c false + * else @c false * @param[in] s An instance of String - * @remarks This method is case sensitive. @n - * It only accepts lowercase strings. + * @remarks This method is case sensitive and accepts only lowercase strings. * * @code * bool b1 = Boolean::Parse(trueString); // trueString is L"true" @@ -204,11 +202,11 @@ public: * @since 2.0 * * @return @c true if the value of the specified string is "true", @n - * else @c false + * else @c false * @param[in] s An instance of String * @param[in] caseSensitive Set to @c true to perform a * case sensitive comparison of string @c s - * @remarks If @c caseSensitive is @c true, L"True" returns @c false, else @c true. + * @remarks If @c caseSensitive is @c true, L"True" returns @c false, else it returns @c true. * * @code * bool b1 = Boolean::Parse(L"True", false ); // Returns @c true @@ -218,11 +216,11 @@ public: static bool Parse(const String& s, bool caseSensitive); /** - * Converts the value of the calling instance from @c bool to String. + * Converts the value of the current instance from @c bool to String. * * @since 2.0 * - * @return @c true if this instance is @c true, @n + * @return @c true if this instance is @c true, @n * else @c false */ String ToString(void) const; @@ -234,9 +232,9 @@ public: * * @since 2.0 * - * @return @c true if the parameter is @c true, @n + * @return @c true if the parameter is @c true, @n * else @c false - * @param[in] value A @c bool value to convert to String + * @param[in] value The @c bool value to convert to String */ static String ToString(bool value); diff --git a/inc/FBaseBuffer.h b/inc/FBaseBuffer.h index a3476c8..f5eb717 100644 --- a/inc/FBaseBuffer.h +++ b/inc/FBaseBuffer.h @@ -18,7 +18,7 @@ * @file FBaseBuffer.h * @brief This is the header file for the %Buffer class. * - * This header file contains the declarations of the %Buffer classes. + * This header file contains the declarations of the %Buffer class. */ #ifndef _FBASE_BUFFER_H_ #define _FBASE_BUFFER_H_ @@ -42,7 +42,7 @@ class ByteBuffer; * * The %Buffer class represents a linear finite sequence of elements of the same type. * It is a means of defining an aggregation of the same type of objects, similar to an array. - * @n + * * For more information on the class features, see Buffer. * * @see Tizen::Base::BufferBase @@ -120,12 +120,10 @@ class _OSP_EXPORT_ Buffer public: /** - * This is the default constructor for this class. - * - * @since 2.0 + * This is the default constructor for this class. @n + * After creating an instance of the %Buffer class, one of the Construct() methods must be called explicitly to initialize this instance. * - * @remarks After creating an instance of the %Buffer class, one of the Construct() methods must be called explicitly to initialize this instance. - * @see Construct() + * @since 2.0 */ Buffer(void) { @@ -152,8 +150,9 @@ public: * * @param[in] buffer The other %Buffer instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the source buffer is not constructed. + * @exception E_INVALID_ARG Either of the following conditions has occured: + * - The specified input parameter is invalid. + * - The source buffer has not been constructed. * @see Buffer() */ result Construct(const Buffer< Type >& buffer) @@ -194,15 +193,18 @@ public: * @since 2.0 * * @return An error code - * @param[in] pBuffer The buffer which is shared + * @param[in] pBuffer The shared buffer * @param[in] index The starting index of the buffer from where the first @c byte value is read - * @param[in] length The number of bytes to read from the given buffer @n This is a limit of this instance. + * @param[in] length The number of bytes to read from the given buffer @n + * This is the limit of this instance. * @param[in] capacity The capacity of this instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c pBuffer is @c null. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the @c index is larger than the @c length. + * @exception E_INVALID_ARG Either of the following conditions has occured: + * - A specified input parameter is invalid. + * - The specified @c pBuffer is @c null. + * @exception E_OUT_OF_RANGE Either of the following conditions has occured: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the specified @c length. */ result Construct(const Type* pBuffer, int index, int length, int capacity) { @@ -236,13 +238,13 @@ public: } /** - * This subscript operator returns the reference to the element indicated by the given @c index. + * Returns a reference to the element indicated by the given @c index. * * @since 2.0 * * @return A reference to the indexed element * @param[in] index The index of the element @n - * It must be less than the limit. + * It must be less than the limit. */ Type& operator [](int index) const { @@ -253,15 +255,15 @@ public: } /** - * Overloaded equality operator to compare two %Buffer instances. + * Checks whether two %Buffer instances are equal. * * @since 2.0 * - * @return @c true if the buffers being compared are equal, @n + * @return @c true if the two %Buffer instances are equal, @n * else @c false - * @param[in] buffer The buffer to compare with the current instance of %Buffer - * @remarks This method returns @c true only if the two buffers have the same number of remaining elements @n - * and the two sequences of remaining elements are equal (considered independently of their starting positions). + * @param[in] buffer The buffer to compare with the current instance of %Buffer + * @remarks This method returns @c true only if the two buffers have the same number of remaining elements @n + * and the sequences of the remaining elements are equal (considered independent of their starting positions). * @see Equals() */ bool operator ==(const Buffer< Type >& buffer) const @@ -289,16 +291,16 @@ public: } /** - * Checks whether the two %Buffer instances are not equal. + * Checks whether two %Buffer instances are not equal. * * @since 2.0 * - * @return @c true if the buffers are not equal, @n + * @return @c true if the two %Buffer instances are not equal, @n * else @c false - * @param[in] buffer The buffer to compare with the current instance of %Buffer - * @remarks This method returns @c false only if the two buffers being compared have the same @n - * number of remaining elements and the two sequences of remaining elements are equal @n - * (considered independently of their starting positions). + * @param[in] buffer The buffer to compare with the current instance of %Buffer + * @remarks This method returns @c false only if the two buffers have the same @n + * number of remaining elements and the sequences of the remaining elements are equal @n + * (considered independent of their starting positions). * @see Equals() */ bool operator !=(const Buffer< Type >& buffer) const @@ -309,29 +311,30 @@ public: /** * Copies the remaining elements of the input %Buffer instance into the current * %Buffer instance. @n - * It returns E_OVERFLOW if the remaining part of the current instance is smaller + * It returns @c E_OVERFLOW if the remaining part of the current instance is smaller * than the remaining part of the input instance. * * @since 2.0 * * @return An error code - * @param[in] buffer The source buffer from which bytes are read @n - * It must not be the current instance of %Buffer. + * @param[in] buffer The source buffer from which bytes are read @n + * It must not be the current instance of %Buffer. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the source buffer is same as destination buffer, + * @exception E_INVALID_ARG Either of the following conditions has occured: + * - The specified input parameter is invalid. + * - The source buffer is same as destination buffer, * that is, the current instance of %Buffer. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow. @n - * The number of remaining bytes of the current buffer is less than - * the number of remaining bytes of the given buffer. + * @exception E_OVERFLOW Either of the following conditions has occured: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The number of remaining bytes in the current buffer is less than + * the number of remaining bytes in the given buffer. * @remarks After the copy operation, the current (destination) buffer's position and the given * (source) buffer's position are incremented by the number of elements copied (the number * of remaining elements of the given buffer). @n * If the remaining part of the current instance is not less than the remaining part of the input instance, - * the effect of this method and the ReadFrom() method is the same. But when the remaining part of the - * current instance is less, ReadFrom() method copies the number of remaining elements of the current - * instance while this method returns E_OVERFLOW and does not transfer. - * @see ReadFrom() + * the effect of this method and the ReadFrom() method is the same. @n + * But when the remaining part of the current instance is less, the ReadFrom() method copies the number of remaining + * elements of the current instance while this method returns @c E_OVERFLOW and does not transfer. * * The following example demonstrates how to use the %CopyFrom() method. * @@ -399,16 +402,17 @@ public: } /** - * Reads the value from the current position in the buffer, and then increments the position. @n - * Provides a way for relative indexing and reading. + * Reads the value of the current position in the buffer, and then increments the position. @n + * Provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code - * @param[out] value The value at the current position + * @param[out] value The value at the current position * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow. @n - * The current position is greater than the limit. + * @exception E_UNDERFLOW Either of the following conditions has occured: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The current position is greater than the limit. * @see Set() */ result Get(Type& value) @@ -421,16 +425,18 @@ public: /** * Reads the value at the given @c index. @n - * Provides a way for absolute indexing and reading. + * Provides a way to preform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index into the buffer from where the value is read - * @param[out] value The value at the given index - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure. @n - * The @c index is greater than the limit or less than @c 0. + * @param[in] index The buffer index from where the value is read + * @param[out] value The value at the given index + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_RANGE Either of the following conditions has occured: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the limit. + * - The specified @c index is less than @c 0. * @see Set() */ result Get(int index, Type& value) const @@ -445,22 +451,25 @@ public: /** - * Copies the specified range of values from the calling buffer to the specified destination array as per the given @c index of the array. + * Copies the specified range of values from the calling buffer to the specified @c index of the destination array. * * @since 2.0 * * @return An error code - * @param[out] pArray A pointer to the array into which values are written - * @param[in] index The starting index in the array of the first value to write - * @param[in] length The number of values from the buffer to write to the array + * @param[out] pArray A pointer to the array into which the values are written + * @param[in] index The starting index in the array where the first value is written + * @param[in] length The number of values to write from the buffer to the array * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c pArray is @c null. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index or length is less than @c 0. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow. @n - * The remaining elements of this buffer are smaller than @c length. - * @remarks After the copy operation, the position is incremented by @c length. + * @exception E_INVALID_ARG Either of the following conditions has occured: + * - A specified input parameter is invalid. + * - The specified @c pArray is @c null. + * @exception E_OUT_OF_RANGE Either of the following conditions has occured: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index or @c length is less than @c 0. + * @exception E_UNDERFLOW Either of the following conditions has occured: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining elements of this buffer are smaller than the specified @c length. + * @remarks After the copy operation, the position is incremented by @c length. * @see SetArray() */ result GetArray(Type* pArray, int index, int length) @@ -478,26 +487,27 @@ public: /** * Transfers bytes from the input buffer into the calling buffer. @n - * If the empty space in the calling buffer is larger than the remaining values from the input buffer, - * all the remaining elements from the input are copied to the destination. @n + * If the empty space in the calling buffer is larger than the remaining values of the input buffer, + * then all the remaining elements from the input are copied to the destination. @n * Otherwise, the number of bytes copied equals the number of elements remaining in the calling buffer. * * @since 2.0 * * @return An error code - * @param[in] buffer The source buffer from where the bytes are read @n - * It must not be this buffer. + * @param[in] buffer The source buffer from where the bytes are read @n + * It must not be this buffer. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. @n - * The given buffer is same as the current buffer instance. + * @exception E_INVALID_ARG Either of the following conditions has occured: + * - The specified input parameter is invalid. + * - The given buffer is same as the current buffer instance. * @remarks After the copy operation, the current (destination) buffer's position and the given - * (source) buffer's position are incremented by the number of elements copied (the smaller value + * (source) buffer's position are incremented by the number of elements copied (the smaller value * between the number of elements remaining in the calling buffer and the source buffer). @n - * If there are more elements remaining in the calling buffer than elements remaining in the input instance, - * this method is equivalent to CopyFrom() method. If there are less remaining elements in the - * calling buffer, the %CopyFrom() method returns @c E_OVERFLOW and does not transfer - * while this method copies the number of remaining elements of the current instance. - * @see CopyFrom() + * If there are more elements remaining in the calling buffer than the elements remaining in the input instance, + * then this method is equivalent to the CopyFrom() method. @n + * If there are less elements remaining in the calling buffer, then the %CopyFrom() method + * returns @c E_OVERFLOW and does not transfer, while this method copies the number of remaining elements + * of the current instance. * * The following example demonstrates how to use the %ReadFrom() method. * @@ -575,15 +585,16 @@ public: /** * Writes the specified @c value into the current buffer instance at the current position, * and then increments the position. @n - * Provides a way for relative indexing and writing. + * Provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] value The value to write to the calling %Buffer + * @param[in] value The value to write into the calling %Buffer * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow. @n - * The current position is not smaller than the limit. + * @exception E_OVERFLOW Either of the following conditions has occured: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The current position is not smaller than the limit. * @see Get() */ result Set(Type value) @@ -595,17 +606,19 @@ public: } /** - * Writes the specified @c value into the current instance of buffer at the given @c index. @n - * Provides a way for absolute indexing and writing. + * Writes the specified @c value into the current instance of the buffer at the given @c index. @n + * Provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index at which the value is written - * @param[in] value The value to write + * @param[in] index The index at which the value is written + * @param[in] value The value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is not smaller than the limit or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occured: + * - The specified index is outside the bounds of the data structure. + * - The specified @c index is not smaller than the limit. + * - The specified @c index is less than @c 0. * @see Get() */ result Set(int index, Type value) @@ -624,19 +637,21 @@ public: * @since 2.0 * * @return An error code - * @param[in] pArray A pointer to the array from where the values are read - * @param[in] index The starting index of the array - * @param[in] length The number of values read from the given array + * @param[in] pArray A pointer to the array from where the values are read + * @param[in] index The starting index of the array + * @param[in] length The number of values read from the given array * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c pArray is @c null. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index or length is less than @c 0. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow. @n - * The remainder of this buffer is smaller than @c length. - * @remarks This method copies @c length number of values from the source array, - * starting from the given @c index in the array, into the calling - * buffer, starting at the current position. + * @exception E_INVALID_ARG Either of the following conditions has occured: + * - A specified input parameter is invalid. + * - The specified @c pArray is @c null. + * @exception E_OUT_OF_RANGE Either of the following conditions has occured: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index or @c length is less than @c 0. + * @exception E_OVERFLOW Either of the following conditions has occured: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remainder of this buffer is smaller than the specified @c length. + * @remarks This method copies @c length number of values starting from the given @c index of the source array, + * into the calling buffer, starting from the current position. @n * After the copy operation, the position is incremented by @c length. * @see GetArray() */ @@ -656,12 +671,12 @@ public: /** * Creates a new %Buffer instance. @n * Its content is a shared portion of - * the calling %Buffer instance that starts from the current position of calling %Buffer instance. + * the calling %Buffer instance that starts from the current position of the calling %Buffer instance. * * @since 2.0 * - * @return A pointer to the new buffer - * @remarks The content of the new buffer starts at the current position of this instance of %Buffer. + * @return A pointer to the new %Buffer instance + * @remarks The content of the new buffer starts at the current position of this %Buffer instance. @n * The new buffer's position is @c 0, its capacity and limit is * the number of bytes remaining in the current instance of %Buffer, * and it is marked as undefined. @@ -695,16 +710,16 @@ public: } /** - * Compares the Object instance with the calling %Buffer instance for equivalence. + * Compares the Object instance with the current %Buffer instance for equality. * * @since 2.0 * - * @return @c true if the input equals the calling %Buffer instance, @n + * @return @c true if the input equals the current %Buffer instance, @n * else @c false - * @param[in] obj The object to compare with the calling %Buffer - * @remarks This method returns @c true if and only if the specified object is also an instance of %Buffer class, + * @param[in] obj The object to compare with the current %Buffer instance + * @remarks This method returns @c true if and only if the specified object is also an instance of %Buffer, * the two buffers have the same number of remaining elements, and the two sequences of - * remaining elements are equal (considered independently of their starting positions). + * remaining elements are equal (considered independent of their starting positions). * @see Tizen::Base::BufferBase::GetHashCode() */ virtual bool Equals(const Tizen::Base::Object& obj) const @@ -724,7 +739,7 @@ public: * * @since 2.0 * - * @return The hash value of the current instance + * @return The hash value of the current instance * @remarks The hash code of a buffer depends only upon its remaining elements. */ virtual int GetHashCode(void) const diff --git a/inc/FBaseBufferBase.h b/inc/FBaseBufferBase.h index 6a07b8e..9858533 100644 --- a/inc/FBaseBufferBase.h +++ b/inc/FBaseBufferBase.h @@ -83,14 +83,15 @@ public: void Clear(void); /** - * Copies the elements between the current position and limit (that are also known as remaining + * Copies the elements between the current position and the limit (that are also known as the remaining * elements), to the beginning of the calling %BufferBase instance. * * @since 2.0 * * @remarks After copying, the position is set to the number of elements copied rather than to @c 0, * so that an invocation of this method can be followed immediately by an invocation - * of another relative set method. The limit is set to the capacity, and the mark is discarded. + * of another relative set method. @n + * The limit is set to the capacity, and the mark is discarded. */ void Compact(void); @@ -101,12 +102,13 @@ public: * * @since 2.0 * - * @param[in] to The value to set the buffer position @n + * @param[in] to The value of the buffer position to set @n * The parameter may contain @c POSITION_TO_ZERO or @c POSITION_TO_MARK. - * @remarks If @c to is POSITION_TO_ZERO (or unspecified), the position is set to @c 0 after setting a limit to + * @remarks If @c to is @c POSITION_TO_ZERO (or unspecified), the position is set to @c 0 after setting a limit to * the current position, and the mark is discarded. - * Otherwise, if @c to is POSITION_TO_MARK, the position is set to the mark and - * the mark is not discarded. If the mark is undefined, the position is set to @c 0. + * Otherwise, if @c to is @c POSITION_TO_MARK, the position is set to the mark and + * the mark is not discarded. @n + * If the mark is undefined, the position is set to @c 0. * * The following example demonstrates how to use the %Flip() method. * @@ -137,7 +139,7 @@ public: * @since 2.0 * * @return The hash value of the calling object - * @remarks The hash code of a buffer depends only upon its remaining elements. + * @remarks The hash code of a buffer depends only upon its remaining elements. * @see Tizen::Base::Object::Equals() */ virtual int GetHashCode(void) const; @@ -158,8 +160,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. @n - * The mark has not been set. + * @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 mark has not been set. * @remarks Invoking this method neither changes nor discards the mark's value. */ result Reset(void); @@ -175,17 +178,20 @@ public: /** * Shifts the limit of the current instance of %BufferBase. @n - * The new limit is the current limit plus the given amount. + * The new limit is the current limit plus the given @c amount. * * @since 2.0 * * @return An error code - * @param[in] amount The quantity of shift needed + * @param[in] amount The quantity of the shift needed * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method. @n - * The @c amount is larger than the capacity or smaller than @c 0 starting from the current limit. - * @remarks If the position is larger than the new limit, it is set to the new limit. - * If the mark is defined and larger than the new limit, it is discarded. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - The @c amount is larger than the capacity starting from the current limit. + * - The @c amount is smaller than @c 0. + * @remarks + * - If the position is larger than the new limit, it is set to the new limit. + * - If the mark is defined and is larger than the new limit, it is discarded. * @see SetLimit() */ result ShiftLimit(int amount); @@ -195,7 +201,7 @@ public: * * @since 2.0 * - * @return The capacity of the calling object + * @return The capacity of the calling %BufferBase instance */ int GetCapacity(void) const; @@ -205,7 +211,7 @@ public: * * @since 2.0 * - * @return The limit of the calling object + * @return The limit of the calling %BufferBase instance * @see SetLimit() */ int GetLimit(void) const; @@ -252,12 +258,15 @@ public: * @since 2.0 * * @return An error code - * @param[in] limit The new limit + * @param[in] limit The limit of the calling %BufferBase instance * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method. @n - * The @c limit is larger than the capacity or less than @c 0. - * @remarks If the position is larger than the new limit, it is set to the new limit. - * If the mark is defined and larger than the new limit, it is discarded. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - The specified @c limit is larger than the capacity. + * - The specified @c limit is less than @c 0. + * @remarks + * - If the position is larger than the new limit, it is set to the new limit. + * - If the mark is defined and is larger than the new limit, it is discarded. * @see GetLimit() */ result SetLimit(int limit); @@ -265,9 +274,9 @@ public: /** * Sets the mark of the current instance of %BufferBase at the current position. @n - * If this method is called after InvalidateMark(), the mark is set to @c -1. + * If this method is called after the InvalidateMark() method , the mark is set to @c -1. * - * @since 2.0 + * @since 2.0 * * @see GetMark() */ @@ -280,36 +289,38 @@ public: * @since 2.0 * * @return An error code - * @param[in] position The new position + * @param[in] position The position of the calling %BufferBase instance * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method. @n - * The @c position is larger than the current limit or less than @c 0. - * @remarks If the mark is defined and larger than the new position then it is discarded. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - The specified @c position is larger than the current limit. + * - The specified @c position is less than @c 0. + * @remarks If the mark is defined and is larger than the new position then it is discarded. * @see GetPosition() */ result SetPosition(int position); /** * Returns @c true if there is at least one element between the current position and - * the limit of the current instance of %BufferBase. Otherwise, it returns @c false. + * the limit of the current %BufferBase instance. Otherwise, it returns @c false. * * @since 2.0 * - * @return @c true if there is at least one element between the current position and the limit of the current instance of %BufferBase, @n + * @return @c true if there is at least one element between the current position and the limit of the current %BufferBase instance, @n * else @c false * @see GetRemaining() */ bool HasRemaining(void) const; /** - * Expands the capacity and the limit of the internal buffer with the specified capacity. + * Expands the capacity and the limit of the internal buffer with the specified @c newCapacity. * * @since 2.0 * * @return An error code * @param[in] newCapacity The new capacity of this instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c capacity is less than the current capacity. + * @exception E_INVALID_ARG The specified @c newCapacity is less than the current capacity. * @remarks After calling this method, the address of the internal buffer may be either the same or a new location. */ result ExpandCapacity(int newCapacity); @@ -386,7 +397,7 @@ protected: virtual ~_BufferData(void); // - // Gets the pointer to the byte array. + // Gets a pointer to the byte array. // // @since 2.0 // @return Pointer to the @c byte array diff --git a/inc/FBaseByteBuffer.h b/inc/FBaseByteBuffer.h index ad5d64d..594667c 100644 --- a/inc/FBaseByteBuffer.h +++ b/inc/FBaseByteBuffer.h @@ -36,7 +36,7 @@ namespace Tizen { namespace Base * * @since 2.0 * - * The %ByteBuffer class provides a means of encapsulating a sequence of bytes in memory. It defines + * The %ByteBuffer class provides a means of encapsulating a sequence of bytes in the memory. It defines * methods to read and write all primitive built-in types (except @c bool), to and from a sequence of * bytes. These methods read the size of primitive type bytes from a @c byte sequence and * convert it to the actual primitive type. @@ -131,13 +131,12 @@ class _OSP_EXPORT_ ByteBuffer public: /** - * The object is not fully constructed after this constructor is called. + * The object is not fully constructed after this constructor is called. @n * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.0 * - * @remarks After creating an instance of the %ByteBuffer class, one of the Construct() methods must be called explicitly to initialize this instance. - * @see Construct() + * @remarks After creating an instance of %ByteBuffer, one of the Construct() methods must be called explicitly to initialize this instance. */ ByteBuffer(void); @@ -149,15 +148,16 @@ public: virtual ~ByteBuffer(void); /** - * Initializes this instance of %ByteBuffer which is a view of the specified buffer. @n - * This is the copy constructor for the %ByteBuffer class. + * Initializes this instance of %ByteBuffer which is a view of the specified @c buffer. @n + * This is the copy constructor of the %ByteBuffer class. * * @since 2.0 * - * @param[in] buffer The %ByteBuffer instance used to initialize new object + * @param[in] buffer The %ByteBuffer instance used to initialize the new object * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the source buffer is not constructed. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The source buffer has not been constructed. * @see ByteBuffer() */ result Construct(const ByteBuffer& buffer); @@ -170,8 +170,9 @@ public: * @return An error code * @param[in] capacity The number of elements * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c capacity is negative. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity is negative. * @see ByteBuffer() */ result Construct(int capacity); @@ -182,22 +183,25 @@ public: * @since 2.0 * * @return An error code - * @param[in] pBuffer The buffer which is shared + * @param[in] pBuffer The shared buffer * @param[in] index The starting index of the buffer from where the first @c byte value is read - * @param[in] length The number of bytes to read from the given buffer @n This is a limit of this instance. + * @param[in] length The number of bytes to read from the given buffer @n + * This is the limit of this instance. * @param[in] capacity The capacity of this instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c pBuffer is @c null. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the @c length. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c pBuffer is @c null. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than or equal to the specfied @c capacity. */ result Construct(const byte* pBuffer, int index, int length, int capacity); /** - * Gets the reference to the byte value at the specified index. + * Gets a reference to the @c byte value at the specified @c index. * - * @since 2.0 + * @since 2.0 * * @return A reference to the @c byte value * @param[in] index The index of the @c byte value in the calling %ByteBuffer instance @n @@ -206,42 +210,42 @@ public: byte& operator [](int index); /** - * Gets the byte value at the specified index of const object. + * Gets the @c byte value at the specified @c index of the constant object. * * @since 2.0 * - * @return A value to the @c byte value + * @return The @c byte value at the specified @c index * @param[in] index The index of the @c byte value in the calling %ByteBuffer instance @n * It must be less than the limit. */ byte operator [](int index) const; /** - * Compares the two %ByteBuffer instances. + * Compares two %ByteBuffer instances. * * @since 2.0 * * @return @c true if the input buffer is equal to the calling %ByteBuffer instance, @n * else @c false * @param[in] buffer The %ByteBuffer instance to compare with the current instance - * @remarks This method returns @c true only if the two buffers have the same number of - * remaining elements, and the two sequences of remaining elements are equal - * (considered independently, irrespective of their starting positions). + * @remarks This method returns @c true if the two buffers have the same number of + * remaining elements, and the sequences of the remaining elements are equal + * (considered independently, irrespective of their starting positions). * @see Equals() */ bool operator ==(const ByteBuffer& buffer) const; /** - * Checks whether the current instance and the specified instance of %ByteBuffer are not equal. + * Checks whether the current instance and the specfied %ByteBuffer instance are not equal. * * @since 2.0 * - * @return @c true if the two objects are not the same, @n + * @return @c true if the current instance and the specified %ByteBuffer instance are not equal, @n * else @c false - * @param[in] buffer The buffer to compare with the current instance - * @remarks This method returns @c false only if the two buffers being compared have the same - * number of remaining elements, and the two sequences of remaining elements are equal - * (considered independently, irrespective of their starting positions). + * @param[in] buffer The %ByteBuffer instance to compare with the current instance + * @remarks This method returns @c false if the two buffers have the same + * number of remaining elements, and the sequences of the remaining elements are equal + * (considered independently, irrespective of their starting positions). * @see Equals() */ bool operator !=(const ByteBuffer& buffer) const; @@ -251,11 +255,12 @@ public: * * @since 2.0 * - * @return DoubleBuffer A pointer to the current position of the calling object - * @remarks The content of the view buffer starts at the current position of the calling buffer. - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of this buffer divided by the size of @c double. - * Any change to the byte buffer content is visible in the @c double buffer view, and vice versa. + * @return DoubleBuffer A pointer to the current position of the calling object + * @remarks + * - The content of the view buffer starts at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c double value. + * - Any change to the byte buffer content is visible in the @c double buffer view, and vice versa. */ DoubleBuffer* AsDoubleBufferN(void) const; @@ -264,11 +269,12 @@ public: * * @since 2.0 * - * @return FloatBuffer A pointer to the current position of the calling buffer - * @remarks The content of the view buffer starts at the current position of the calling buffer. - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of the calling buffer divided by the size of @c float. - * Any change to the byte buffer content is visible in the @c float buffer view, and vice versa. + * @return FloatBuffer A pointer to the current position of the calling buffer + * @remarks + * - The content of the view buffer starts at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c float value. + * - Any change to the byte buffer content is visible in the @c float buffer view, and vice versa. */ FloatBuffer* AsFloatBufferN(void) const; @@ -277,11 +283,12 @@ public: * * @since 2.0 * - * @return IntBuffer A pointer to the current position of the calling buffer - * @remarks The content of the view buffer starts at the current position of the calling buffer. - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of calling buffer divided by the size of @c int. - * Any change to the byte buffer content is visible in the Int buffer view, and vice versa. + * @return IntBuffer A pointer to the current position of the calling buffer + * @remarks + * - The content of the view buffer starts at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c int value. + * - Any change to the byte buffer content is visible in the @c int buffer view, and vice versa. */ IntBuffer* AsIntBufferN(void) const; @@ -290,11 +297,12 @@ public: * * @since 2.0 * - * @return LongBuffer A pointer to the current position of the calling buffer - * @remarks The content of the view buffer starts at the current position of this buffer. - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of calling buffer divided by the size of @c long. - * Any change to the byte buffer content is visible in the @c long buffer view, and vice versa. + * @return LongBuffer A pointer to the current position of the calling buffer + * @remarks + * - The content of the view buffer starts at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c long value. + * - Any change to the byte buffer content is visible in the @c long buffer view, and vice versa. */ LongBuffer* AsLongBufferN(void) const; @@ -303,11 +311,12 @@ public: * * @since 2.0 * - * @return LongLongBuffer A pointer to the current position of the calling buffer - * @remarks The content of the view buffer starts at the current position of this buffer. - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of calling buffer divided by the size of @c long. - * Any change to the byte buffer content is visible in the @c long @c long buffer view, and vice versa. + * @return LongLongBuffer A pointer to the current position of the calling buffer + * @remarks + * - The content of the view buffer starts at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c long @c long value. + * - Any change to the byte buffer content is visible in the @c long @c long buffer view, and vice versa. */ LongLongBuffer* AsLongLongBufferN(void) const; @@ -315,31 +324,32 @@ public: * @if OSPDEPREC * Creates a new @c mchar buffer view of the underlying content of the byte buffer. * - * @brief [Deprecated] - * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. - * Instead of using this method, use the AsWcharBufferN() method. + * @brief [Deprecated] + * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. + * Instead of using this method, use the AsWcharBufferN() method. * @since 2.0 * - * @return McharBuffer A pointer to the current position of the calling buffer - * @remarks The content of the view buffer starts at the current position of this buffer. - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of the calling buffer divided by the size of @c long. - * Any change to the byte buffer content is visible in the @c mchar buffer view, and vice versa. + * @return McharBuffer A pointer to the current position of the calling buffer + * @remarks + * - The content of the view buffer starts at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c mchar value. + * - Any change to the byte buffer content is visible in the @c mchar buffer view, and vice versa. * @endif */ McharBuffer* AsMcharBufferN(void) const; /** - * Creates a new wchar Buffer view of the underlying content of the byte buffer. + * Creates a new @c wchar buffer view of the underlying content of the byte buffer. * * @since 2.0 * - * @return WcharBuffer pointer to the current position of the calling buffer - * @remarks The content of the view buffer start at the current position of this buffer. @n - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of the calling buffer divided by the size of @c long. @n - * Any changes to the calling buffer's content (that is, the content of %ByteBuffer instance) @n - * are visible in the WcharBuffer view, and vice versa. + * @return WcharBuffer A pointer to the current position of the calling buffer + * @remarks + * - The content of the view buffer start at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c wchar value. + * - Any change to the byte buffer content is visible in the @c wchar buffer view, and vice versa. */ WcharBuffer* AsWcharBufferN(void) const; @@ -348,39 +358,42 @@ public: * * @since 2.0 * - * @return ShortBuffer pointer to the current position of the calling buffer - * @remarks The content of the view buffer starts at the current position of this buffer. - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of calling buffer divided by the size of @c long. - * Any change to the byte buffer content is visible in the @c short buffer view, and vice versa. + * @return ShortBuffer A pointer to the current position of the calling buffer + * @remarks + * - The content of the view buffer starts at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c short value. + * - Any change to the byte buffer content is visible in the @c short buffer view, and vice versa. */ ShortBuffer* AsShortBufferN(void) const; /** * Copies the remaining bytes of the input %ByteBuffer instance into the calling %ByteBuffer object. @n - * It returns E_OVERFLOW if the remaining bytes in the current instance are less + * It returns @c E_OVERFLOW if the remaining bytes in the current instance are less * than the remaining bytes in the input instance. * * @since 2.0 * * @return An error code - * @param[in] buffer The source buffer from which bytes are read @n - * It must not be the calling object. + * @param[in] buffer The source buffer from which bytes are read @n + * It must not be the calling object. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. @n - * The source buffer is same as destination buffer, - * that is, the current instance of the buffer. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow. @n - * The number of remaining bytes of the current buffer is smaller than - * the number of remaining bytes of the input buffer. - * @remarks After the copy operation, the current (destination) buffer's position and the given + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The source buffer is same as the destination buffer, + * that is, the current instance of the buffer. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The number of remaining bytes in the current buffer is smaller than + * the number of remaining bytes in the input buffer. + * @remarks + * - After the copy operation, the current (destination) buffer's position and the given * (source) buffer's positions are incremented by the number of bytes copied (the number of - * remaining bytes of the given buffer). @n - * If the remaining part of the current instance is greater than or equal to the remaining part of the input instance, - * the effect of this method and the ReadFrom(%ByteBuffer) method is the same. But when the remaining part of the - * current instance is less, the ReadFrom() method copies the number of remaining elements of the current - * instance while this method returns E_OVERFLOW and does not copy. - * @see ReadFrom() + * remaining bytes in the given buffer). + * - If the remaining part of the current instance is greater than or equal to the remaining part of the input instance, + * the effect of this method and the ReadFrom() method is the same. @n + * If the remaining part of the current instance is less, the %ReadFrom() method + * copies the number of remaining elements of the current instance while this method returns @c E_OVERFLOW and does not copy. * * The following example demonstrates how to use the %CopyFrom() method. * @@ -439,18 +452,21 @@ public: * @since 2.0 * * @return An error code - * @param[out] pArray A pointer to the destination array into which the bytes are written - * @param[in] index The starting index in the array of the first byte to write - * @param[in] length The number of bytes to write to the given array + * @param[out] pArray A pointer to the destination array into which the bytes are written + * @param[in] index The starting index of the array where the first byte is written + * @param[in] length The number of bytes to write into the given array * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c pArray is @c null. - * @exception E_OUT_OF_RANGE A specified input parameter is invalid. @n - * The @c index or @c length is less than @c 0. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than @c length. - * @remarks This method copies @c length bytes from the current instance of %ByteBuffer to the given array, - * starting at the current position and at the given index in the array. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c pArray is @c null. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c index or the specified @c length is less than @c 0. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the specified @c length. + * @remarks This method copies @c length bytes from the current instance of %ByteBuffer into the given array, + * starting from the current position and the given index in the array. @n * After the copy operation, the position is incremented by @c length bytes. * @see SetArray() */ @@ -458,354 +474,381 @@ public: /** * Gets the @c byte value from the buffer at the current position, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c byte value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the current position is not smaller than the limit. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The current position is not smaller than the limit. * @see SetByte() */ result GetByte(byte& value); /** * Gets the @c byte value at the given index. @n - * Provides a way for absolute indexing and reading. + * It provides a way to perform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the byte is read - * @param[out] value The @c byte value at the given @c index + * @param[in] index The index of the current %ByteBuffer instance, from which the byte is read + * @param[out] value The @c byte value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is not smaller than the limit or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is not smaller than the limit. + * - The specified @c index is less than @c 0. * @see SetByte() */ result GetByte(int index, byte& value) const; /** - * Gets the size of @c double number of bytes from the buffer at the current position, converts + * Gets the size of the @c double number of bytes from the buffer at the current position, converts * it to the corresponding @c double equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c double value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c double. - * @remarks This method reads the next size of @c double number of bytes at the current position, - * composing it into a @c double value, and then increments the position by the size of @c double. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes in this buffer are smaller than the size of the @c double value. + * @remarks This method reads the next size of the @c double number of bytes at the current position, + * converts it into a @c double value, and then increments the position by the size of the @c double value. * @see SetDouble() */ result GetDouble(double& value); /** - * Gets the size of @c double number of bytes at the given index and converts it to the equivalent @c double value. @n - * Provides a way for absolute indexing and reading. + * Gets the size of the @c double number of bytes at the given index and converts it to the equivalent @c double value. @n + * It provides a way to perform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c double value at the given index + * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read + * @param[out] value The @c double value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c double or less than @c 0. - * @remarks This method reads size of @c double number of bytes at the given index, - * composing them into a @c double value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c double value. + * - The specified @c index is less than @c 0. + * @remarks This method reads the size of the @c double number of bytes at the given @c index + * and converts it into a @c double value. * @see SetDouble() */ result GetDouble(int index, double& value) const; /** - * Gets the size of @c float number of bytes from the buffer at the current position, converts + * Gets the size of the @c float number of bytes from the buffer at the current position, converts * it to the corresponding @c float equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c float value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c float. - * @remarks This method reads the next size of @c float number of bytes at the current position, - * composing it into a @c float value, and then increments the position by the size of @c float. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the size of the @c float value. + * @remarks This method reads the next size of the @c float number of bytes at the current position, + * converts it into a @c float value, and then increments the position by the size of the @c float value. * @see SetFloat() */ result GetFloat(float& value); /** - * Gets the size of @c float number of bytes at the given index and converts it to equivalent @c float value. @n - * Provides a way for absolute indexing and reading. + * Gets the size of the @c float number of bytes at the given index and converts it to an equivalent @c float value. @n + * It provides a way to perform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c float value at the given index + * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read + * @param[out] value The @c float value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c float or less than @c 0. - * @remarks This method reads the size of @c float number of bytes at the given index, - * composing it into a @c float value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c float value. + * - The specified @c index is less than @c 0. + * @remarks This method reads the size of the @c float number of bytes at the given @c index + * and converts it into a @c float value. * @see SetFloat() */ result GetFloat(int index, float& value) const; /** - * Gets the size of @c int number of bytes from the buffer at the current position, converts + * Gets the size of the @c int number of bytes from the buffer at the current position, converts * it to the corresponding @c int equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c int value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c int. - * @remarks This method reads the next size of @c int number of bytes at the current position, - * composing them into an @c int value, and then increments the position by the size of @c int. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the size of the @c int value. + * @remarks This method reads the next size of the @c int number of bytes at the current position, + * converts them into an @c int value, and then increments the position by the size of the @c int value. * @see SetInt() */ result GetInt(int& value); /** - * Gets the size of @c int number of bytes at the given index and converts it to the equivalent @c int value. @n - * Provides a way for absolute indexing and reading. + * Gets the size of the @c int number of bytes at the given @c index and converts it to the equivalent @c int value. @n + * It provides a way to perform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c int value at the given index + * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read + * @param[out] value The @c int value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c int or negative. - * @remarks This method reads the size of @c int number of bytes at the given index, - * composing it into an @c int value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c int. + * - The specified @c index is negative. + * @remarks This method reads the size of the @c int number of bytes at the given @c index + * and converts it into an @c int value. * @see SetInt() */ result GetInt(int index, int& value) const; /** - * Gets the size of @c long number of bytes from the buffer at the current position, converts + * Gets the size of the @c long number of bytes from the buffer at the current position, converts * it to the corresponding @c long equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c long value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c long. - * @remarks This method reads the next size of @c long number of bytes at the current position, - * composing it into a @c long value, and then increments the position by the size of @c long. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the size of the @c long value. + * @remarks This method reads the next size of the @c long number of bytes at the current position, + * converts it into a @c long value, and then increments the position by the size of the @c long value. * @see SetLong() */ result GetLong(long& value); /** - * Gets the size of @c long number of bytes at the given index and converts it to equivalent @c long value. @n - * Provides a way for absolute indexing and reading. + * Gets the size of the @c long number of bytes at the given @c index and converts it to the equivalent @c long value. @n + * It provides a way to perform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c long value at the given index + * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read + * @param[out] value The @c long value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c long or less than @c 0. - * @remarks This method reads the size of @c long number of bytes at the given index, - * composing it into a @c long value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c long value. + * - The specified @c index is less than @c 0. + * @remarks This method reads the size of the @c long number of bytes at the given @c index + * and converts it into a @c long value. * @see SetLong() */ result GetLong(int index, long& value) const; /** - * Gets the size of @c long @c long number of bytes from the buffer at the current position, converts + * Gets the size of the @c long @c long number of bytes from the buffer at the current position, converts * it to the corresponding @c long @c long equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c long @c long value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c long @c long. - * @remarks This method reads the next size of @c long @c long number of bytes at the current position, - * composing it into a @c long @c long value, and then increments the position by the size of @c long @c long. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the size of the @c long @c long value. + * @remarks This method reads the next size of the @c long @c long number of bytes at the current position, + * converts it into a @c long @c long value, and then increments the position by the size of the @c long @c long value. * @see SetLongLong() */ result GetLongLong(long long& value); /** - * Gets the size of @c long @c long number of bytes at the given index and converts it to the equivalent @c long @c long value. @n - * Provides a way for absolute indexing and reading. + * Gets the size of the @c long @c long number of bytes at the given @c index and converts it to the equivalent @c long @c long value. @n + * It provides a way to perform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c long @c long value at the given index + * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read + * @param[out] value The @c long @c long value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c long @c long or less than @c 0. - * @remarks This method reads the size of @c long @c long number of bytes at the given index, - * composing it into a @c long @c long value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c long @c long value. + * - The specified @c index is less than @c 0. + * @remarks This method reads the size of the @c long @c long number of bytes at the given @c index + * and converts it into a @c long @c long value. * @see SetLongLong() */ result GetLongLong(int index, long long& value) const; /** * @if OSPDEPREC - * Gets the size of @c wchar_t number of bytes from the buffer at the current position, converts + * Gets the size of the @c wchar_t number of bytes from the buffer at the current position, converts * it to the corresponding @c wchar_t equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * - * @brief [Deprecated] - * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. - * Instead of using this method, use the GetWchar(wchar_t& value) method. + * @brief [Deprecated] + * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. + * Instead of using this method, use the GetWchar(wchar_t& value) method. * @since 2.0 * * @return An error code * @param[out] value The @c wchar_t value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c wchar_t. - * @remarks This method reads the next size of @c wchar_t number of bytes at the current position, - * composing it into a @c wchar_t value, and then increments the position by the size of @c wchar_t. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value. + * @remarks This method reads the next size of the @c wchar_t number of bytes at the current position, + * converts it into a @c wchar_t value, and then increments the position by the size of the @c wchar_t value. * @see SetMchar() * @endif */ result GetMchar(wchar_t& value); /** - * Gets the size of @c wchar_t number of bytes from the buffer at the current position, converts + * Gets the size of the @c wchar_t number of bytes from the buffer at the current position, converts * it to the corresponding @c wchar_t equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c wchar_t value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c wchar_t. - * @remarks This method reads the next size of @c wchar_t number of bytes at the current position, - * composing it into a @c wchar_t value, and then increments the position by the size of @c wchar_t. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value. + * @remarks This method reads the next size of the @c wchar_t number of bytes at the current position, + * converts it into a @c wchar_t value, and then increments the position by the size of the @c wchar_t value. * @see SetWchar() */ result GetWchar(wchar_t& value); /** * @if OSPDEPREC - * Provides a way for absolute indexing and reading. @n - * It reads the size of @c wchar_t number of bytes at the given index and converts it to equivalent @c wchar_t value. + * Provides a way to perform absolute indexing and reading. @n + * It reads the size of the @c wchar_t number of bytes at the given @c index and converts it to the equivalent @c wchar_t value. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. - * Instead of using this method, use the GetWchar(int index, wchar_t& value) method. + * Instead of using this method, use the GetWchar(int index, wchar_t& value) method. * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c wchar_t value at the given index + * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read + * @param[out] value The @c wchar_t value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c wchar_t or less than @c 0. - * @remarks This method reads the size of @c wchar_t number of bytes at the given index, - * composing it into a @c wchar_t value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c wchar_t value. + * - The specified @c index is less than @c 0. + * @remarks This method reads the size of the @c wchar_t number of bytes at the given @c index + * and converts it into a @c wchar_t value. * @see SetMchar() * @endif */ result GetMchar(int index, wchar_t& value) const; /** - * Provides a way for absolute indexing and reading. @n - * It reads the size of @c wchar_t number of bytes at the given index and converts it to equivalent @c wchar_t value. + * Provides a way to perform absolute indexing and reading. @n + * It reads the size of the @c wchar_t number of bytes at the given @c index and converts it to the equivalent @c wchar_t value. * * @since 2.0 * * @return An error code * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c wchar_t value at the given index + * @param[out] value The @c wchar_t value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c wchar_t or less than @c 0. - * @remarks This method reads the size of @c wchar_t number of bytes at the given index, - * composing it into a @c wchar_t value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c wchar_t value. + * - The specified @c index is less than @c 0. + * @remarks This method reads the size of the @c wchar_t number of bytes at the given @c index + * and converts it into a @c wchar_t value. * @see SetWchar() */ result GetWchar(int index, wchar_t& value) const; /** - * Gets the size of @c short number of bytes from the buffer at the current position, converts + * Gets the size of the @c short number of bytes from the buffer at the current position, converts * it to the corresponding @c short equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * Provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c short value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c short. - * @remarks This method reads the next size of @c short number of bytes at the current position, - * composing it into a @c short value, and then increments the position by the size of @c short. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the size of the @c short value. + * @remarks This method reads the next size of the @c short number of bytes at the current position, + * converts it into a @c short value, and then increments the position by the size of the @c short value. * @see SetShort() */ result GetShort(short& value); /** - * Gets the size of @c short number of bytes at the given index and converts it to the equivalent @c short value. @n - * Provides a way for absolute indexing and reading. + * Gets the size of the @c short number of bytes at the given @c index and converts it to the equivalent @c short value. @n + * Provides a way to perform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c short value at the given index + * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read + * @param[out] value The @c short value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c short or less than @c 0. - * @remarks This method reads the size of @c short number of bytes at the given index, - * composing it into a @c short value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c short value. + * - The specified @c index is less than @c 0. + * @remarks This method reads the size of the @c short number of bytes at the given @c index + * and converts it into a @c short value. * @see SetShort() */ result GetShort(int index, short& value) const; /** - * Copies the remaining bytes of the input %ByteBuffer instance into the calling %ByteBuffer instance + * Copies the remaining bytes of the input %ByteBuffer instance into the calling %ByteBuffer instance, * if the remaining part of the current instance is greater than or equal to the remaining part of the input instance. @n * Otherwise, the number of bytes copied is equal to the number of remaining elements of the current instance. * * @since 2.0 * * @return An error code - * @param[in] buffer The source buffer from which bytes are read @n - * It must not be the calling %ByteBuffer instance. + * @param[in] buffer The source buffer from which bytes are read @n + * It must not be the calling %ByteBuffer instance. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * - * @remarks After the copy operation, the current (destination) buffer's position and the given - * (source) buffer's position are incremented by the number of elements copied (the lesser of - * the number of elements remaining in the current buffer and the given buffer). @n - * If the remaining part of the current instance is greater than or equal to the remaining part of the input instance, - * the effect of this method is the same as the CopyFrom() method. But when the remaining part of the - * current instance is less, the CopyFrom() method returns E_OVERFLOW and does not transfer; + * @remarks + * - After the copy operation, the current (destination) buffer's position and the given + * (source) buffer's position are incremented by the number of elements copied (the lesser of + * the number of elements remaining in the current buffer and the given buffer). + * - If the remaining part of the current instance is greater than or equal to the remaining part of the input instance, + * the effect of this method is the same as the CopyFrom() method. @n + * If the remaining part of the current instance is less, the %CopyFrom() method returns @c E_OVERFLOW and does not transfer; * whereas this method copies the number of remaining elements of the current instance. - * @see CopyFrom() * * The following example demonstrates how to use the %ReadFrom() method. * @@ -866,24 +909,27 @@ public: result ReadFrom(ByteBuffer& buffer); /** - * Sets the @c byte values on the specified array to the current instance of %ByteBuffer. + * Sets the @c byte values in the specified array to the current instance of %ByteBuffer. * * @since 2.0 * * @return An error code - * @param[in] pArray The array from which bytes are read - * @param[in] index The starting index of the array from where the first @c byte value is read - * @param[in] length The number of bytes to read from the given array + * @param[in] pArray The array from which the bytes are read + * @param[in] index The starting index of the array from where the first @c byte value is read + * @param[in] length The number of bytes to read from the given array * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c pArray is @c null. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index or length is less than @c 0. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes are smaller than @c length. - * @remarks This method copies the specified number (@c length) of @c byte values into - * the calling object of buffer from the source array, - * starting from the current position, and at the given index in the array. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c pArray is @c null. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index or the specified @c length is less than @c 0. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes are smaller than the specified @c length. + * @remarks This method copies the specified number (@c length) of @c byte values from the source array + * into the calling object of the buffer, starting from the current position, + * and at the given index in the array. @n * After the copy operation, the position is incremented by @c length. * @see GetArray() */ @@ -892,31 +938,34 @@ public: /** * Sets the given @c byte value into the calling %ByteBuffer object * at the current position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c byte value to write to the current instance of %ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the current position is not smaller than the limit. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The current position is not smaller than the limit. * @see GetByte() */ result SetByte(byte value); /** - * Sets the given @c byte value into the calling %ByteBuffer object at the specified index. @n - * Provides a way for absolute indexing and writing. + * Sets the given @c byte value into the calling %ByteBuffer object at the specified @c index. @n + * Provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current instance of %ByteBuffer at which the byte is written - * @param[in] value The @c byte value to write + * @param[in] index The index of the current instance of %ByteBuffer at which the byte is written + * @param[in] value The @c byte value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is not smaller than the limit or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is not smaller than the limit. + * - The specified @c index is less than @c 0. * @see GetByte() */ result SetByte(int index, byte value); @@ -924,17 +973,18 @@ public: /** * Sets the given @c double value into the calling %ByteBuffer object * at the current position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c double value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than the size of @c double. - * @remarks This method writes the size of @c double number of bytes containing the given @c double value - * into the calling buffer, at the current position, and then increments the position by the size of @c double. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c double value. + * @remarks This method writes the size of the @c double number of bytes containing the given @c double value + * into the calling buffer, at the current position, and then increments the position by the size of the @c double value. * @see GetDouble() */ result SetDouble(double value); @@ -942,17 +992,18 @@ public: /** * Sets the given @c float value into the calling %ByteBuffer object * at the current position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c float value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than the size of @c float. - * @remarks This method writes the size of @c float number of bytes containing the given @c float value - * into this buffer at the current position, and then increments the position by the size of @c float. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c float value. + * @remarks This method writes the size of the @c float number of bytes containing the given @c float value + * into the calling buffer, at the current position, and then increments the position by the size of the @c float value. * @see GetFloat() */ result SetFloat(float value); @@ -960,17 +1011,18 @@ public: /** * Sets the given @c int value into the calling %ByteBuffer instance at the current * position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c int value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than the size of @c int. - * @remarks This method writes the size of @c int number of bytes containing the given @c int value - * into this buffer at the current position, and then increments the position by the size of @c int. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c int value. + * @remarks This method writes the size of the @c int number of bytes containing the given @c int value + * into the calling buffer, at the current position, and then increments the position by the size of the @c int value. * @see GetInt() */ result SetInt(int value); @@ -978,263 +1030,285 @@ public: /** * Sets the given @c long value into the calling %ByteBuffer instance at the current * position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c long value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than size of @c long. - * @remarks This method writes the size of @c long number of bytes containing the given @c long value - * into this buffer at the current position, and then increments the position by the size of @c long. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c long value. + * @remarks This method writes the size of the @c long number of bytes containing the given @c long value + * into the calling buffer, at the current position, and then increments the position by the size of the @c long value. * @see GetLong() */ result SetLong(long value); /** - * Sets the given @c long @c long value into the calling %ByteBuffer object at the current + * Sets the given @c long @c long value into the calling %ByteBuffer instance at the current * position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c long @c long value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than the size of @c long @c long. - * @remarks This method writes the size of @c long @c long number of bytes containing the given @c long @c long value - * into this buffer at the current position, and then increments the position by the size of @c long @c long. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c long @c long value. + * @remarks This method writes the size of the @c long @c long number of bytes containing the given @c long @c long value + * into the calling buffer, at the current position, and then increments the position by the size of the @c long @c long value. * @see GetLongLong() */ result SetLongLong(long long value); /** * @if OSPDEPREC - * Sets the given @c wchar_t value into the calling %ByteBuffer object at the current + * Sets the given @c wchar_t value into the calling %ByteBuffer instance at the current * position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * - * @brief [Deprecated] - * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. - * Instead of using this method, use the SetWchar(wchar_t value) method. + * @brief [Deprecated] + * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. + * Instead of using this method, use the SetWchar(wchar_t value) method. * @since 2.0 * * @return An error code * @param[in] value The @c wchar_t value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than size of @c wchar_t. - * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value - * into this buffer at the current position, and then increments the position by the size of @c wchar_t. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value. + * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value + * into the calling buffer, at the current position, and then increments the position by the size of the @c wchar_t value. * @see GetMchar() * @endif */ result SetMchar(wchar_t value); /** - * Sets the given @c wchar_t value into the calling %ByteBuffer object at the current + * Sets the given @c wchar_t value into the calling %ByteBuffer instance at the current * position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c wchar_t value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than size of @c wchar_t. - * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value - * into this buffer at the current position, and then increments the position by the size of @c wchar_t. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value. + * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value + * into the calling buffer, at the current position, and then increments the position by the size of the @c wchar_t value. * @see GetWchar() */ result SetWchar(wchar_t value); /** - * Sets the given @c short value into the current instance of %ByteBuffer at the current + * Sets the given @c short value into the current %ByteBuffer instance at the current * position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * Provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c short value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than the size of @c short. - * @remarks This method writes the size of @c short number of bytes containing the given @c short value - * into this buffer at the current position, and then increments the position by the size of @c short. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c short value. + * @remarks This method writes the size of the @c short number of bytes containing the given @c short value + * into the calling buffer, at the current position, and then increments the position by the size of the @c short value. * @see GetShort() */ result SetShort(short value); /** - * Sets a @c double value at the specified index of the current instance of %ByteBuffer. @n - * Provides a way for absolute indexing and writing. + * Sets a @c double value at the specified @c index of the current %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index of current instance of %ByteBuffer at which the bytes are written - * @param[in] value The @c double value to write + * @param[in] index The index of the current instance of %ByteBuffer at which the bytes are written + * @param[in] value The @c double value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus the size of @c double or less than @c 0. - * @remarks This method writes the size of @c double number of bytes containing the given @c double value - * into this buffer at the given index. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c double value. + * - The specified @c index is less than @c 0. + * @remarks This method writes the size of the @c double number of bytes containing the given @c double value + * into the calling buffer, at the given @c index. * @see GetDouble() */ result SetDouble(int index, double value); /** - * Sets a @c float value at the specified index of the calling %ByteBuffer object. @n - * Provides a way for absolute indexing and writing. + * Sets a @c float value at the specified @c index of the calling %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index of current instance of %ByteBuffer at which the bytes are written - * @param[in] value The @c float value to write + * @param[in] index The index of the current instance of %ByteBuffer at which the bytes are written + * @param[in] value The @c float value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus the size of @c float or less than @c 0. - * @remarks This method writes the size of @c float number of bytes containing the given @c float value - * into this buffer at the given index. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c float value. + * - The specified @c index is less than @c 0. + * @remarks This method writes the size of the @c float number of bytes containing the given @c float value + * into the calling buffer, at the given @c index. * @see GetFloat() */ result SetFloat(int index, float value); /** - * Sets a @c int value at the specified index of the calling %ByteBuffer object. @n - * Provides a way for absolute indexing and writing. + * Sets a @c int value at the specified @c index of the calling %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index of current instance of %ByteBuffer at which the bytes are written - * @param[in] value The @c int value to write - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c int or less than @c 0. - * @remarks This method writes the size of @c int number of bytes containing the given @c int value - * into this buffer at the given index. + * @param[in] index The index of the current instance of %ByteBuffer at which the bytes are written + * @param[in] value The @c int value to write + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c int value. + * - The specified @c index is less than @c 0 + * @remarks This method writes the size of the @c int number of bytes containing the given @c int value + * into the calling buffer, at the given @c index. * @see GetInt() */ result SetInt(int index, int value); /** - * Sets a @c long value at the specified index of the calling %ByteBuffer object. @n - * Provides a way for absolute indexing and writing. + * Sets a @c long value at the specified index of the calling %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index at which the bytes are written - * @param[in] value The @c long value to write + * @param[in] index The index at which the bytes are written + * @param[in] value The @c long value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus the size of @c long or less than @c 0. - * @remarks This method writes size of @c long number of bytes containing the given @c long value - * into this buffer at the given index. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c long value. + * - The specified @c index is less than @c 0. + * @remarks This method writes the size of the @c long number of bytes containing the given @c long value + * into the calling buffer, at the given @c index. * @see GetLong() */ result SetLong(int index, long value); /** - * Sets a @c long @c long value at the specified index of the calling %ByteBuffer object. @n - * Provides a way for absolute indexing and writing. + * Sets a @c long @c long value at the specified @c index of the calling %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index at which the bytes will be written - * @param[in] value The @c long @c long value to write + * @param[in] index The index at which the bytes are written + * @param[in] value The @c long @c long value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus the size of @c long @c long or less than @c 0. - * @remarks This method writes the size of @c long @c long number of bytes containing the given @c long @c long value - * into this buffer at the given index. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c long @c long value. + * - The specified @c index is less than @c 0. + * @remarks This method writes the size of the @c long @c long number of bytes containing the given @c long @c long value + * into the calling buffer, at the given @c index. * @see GetLongLong() */ result SetLongLong(int index, long long value); /** * @if OSPDEPREC - * Sets a @c wchar_t value at the specified index of the calling %ByteBuffer object. @n - * Provides a way for absolute indexing and writing. + * Sets a @c wchar_t value at the specified @c index of the calling %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * - * @brief [Deprecated] - * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. - * Instead of using this method, use the SetWchar(int index, wchar_t value) method. + * @brief [Deprecated] + * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. + * Instead of using this method, use the SetWchar(int index, wchar_t value) method. * @since 2.0 * * @return An error code - * @param[in] index The index at which the bytes will be written - * @param[in] value The @c wchar_t value to write + * @param[in] index The index at which the bytes are written + * @param[in] value The @c wchar_t value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus the size of @c wchar_t or less than @c 0. - * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value - * into this buffer at the given index. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c wchar_t value. + * - The specified @c index is less than @c 0. + * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value + * into the calling buffer, at the given @c index. * @see GetMchar() * @endif */ result SetMchar(int index, wchar_t value); /** - * Sets a @c wchar_t value at the specified index of the calling %ByteBuffer object. @n - * Provides a way for absolute indexing and writing. + * Sets a @c wchar_t value at the specified @c index of the calling %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index at which the bytes will be written + * @param[in] index The index at which the bytes are written * @param[in] value The @c wchar_t value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus the size of @c wchar_t or less than @c 0. - * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value - * into this buffer at the given index. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c wchar_t value. + * - The specified @c index is less than @c 0. + * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value + * into the calling buffer, at the given @c index. * @see GetWchar() */ result SetWchar(int index, wchar_t value); /** - * Sets a @c short value at the specified index of the calling %ByteBuffer object. @n - * Provides a way for absolute indexing and writing. + * Sets a @c short value at the specified @c index of the calling %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index of at which the bytes are written - * @param[in] value The @c short value to write + * @param[in] index The index of at which the bytes are written + * @param[in] value The @c short value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus the size of @c short or less than @c 0. - * @remarks This method writes the size of @c short number of bytes containing the given @c short value - * into this buffer at the given index. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c short value. + * - The specified @c index is less than @c 0. + * @remarks This method writes the size of the @c short number of bytes containing the given @c short value + * into the calling buffer, at the given @c index. * @see GetShort() */ result SetShort(int index, short value); /** * Creates a new %ByteBuffer whose content is a shared portion of - * the content of the calling %ByteBuffer object. + * the content of the calling %ByteBuffer instance. * * @since 2.0 * - * @return %ByteBuffer pointer to the current position of the calling object - * @remarks The content of the new buffer starts at the current position of the calling %ByteBuffer object. - * The new buffer's position is zero, its capacity and limit are - * the number of bytes remaining of the current instance of %ByteBuffer, + * @return A %ByteBuffer pointer to the current position of the calling object + * @remarks + * - The content of the new buffer starts at the current position of the calling %ByteBuffer object. + * - The new buffer's position is zero, its capacity and limit are + * the number of bytes remaining in the current instance of %ByteBuffer, * and its mark is undefined. */ ByteBuffer* SliceN(void) const; /** - * Gets the pointer to the raw array of the calling buffer. @n + * Gets a pointer to the raw array of the calling buffer. @n * If the capacity is zero, it returns @c null. * * @since 2.0 @@ -1244,12 +1318,12 @@ public: const byte* GetPointer(void) const; /** - * Gets the pointer to the raw array of the calling buffer. @n + * Gets a pointer to the raw array of the calling buffer. @n * If the capacity is zero, it returns @c null. * * @since 2.1 * - * @return A pointer(non-const) to the raw array of the calling buffer + * @return A pointer (non-constant) to the raw array of the calling buffer */ byte* GetPointer(void); @@ -1258,12 +1332,12 @@ public: * * @since 2.0 * - * @return @c true if the input object equals the calling %ByteBuffer instance, @n + * @return @c true if the input Object equals the calling %ByteBuffer instance, @n * else @c false - * @param[in] obj The object instance to compare with the calling object - * @remarks This method returns @c true only if the specified object is also an instance of - * the %ByteBuffer class, the two buffers have the same number of remaining elements, and the two - * sequences of remaining elements are equal (considered independent of their starting positions). + * @param[in] obj The Object instance to compare with the calling object + * @remarks This method returns @c true only if the specified object is also an instance of + * the %ByteBuffer class, the two buffers have the same number of remaining elements, and the + * sequences of the remaining elements are equal (considered independent of their starting positions). * @see Tizen::Base::BufferBase::GetHashCode() */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -1273,7 +1347,7 @@ public: * * @since 2.0 * - * @return The hash value of the current instance + * @return The hash value of the current instance * @remarks The hash code of a buffer depends only upon its remaining elements. */ virtual int GetHashCode(void) const; diff --git a/inc/FBaseCharacter.h b/inc/FBaseCharacter.h index 483894e..e6af8c6 100644 --- a/inc/FBaseCharacter.h +++ b/inc/FBaseCharacter.h @@ -32,32 +32,32 @@ namespace Tizen { namespace Base /** * @enum UnicodeCategory * - * Defines the constants used to distinguish the categories of Unicode characters. + * Defines the constants used to distinguish the categories of the Unicode characters. * * @since 2.0 */ enum UnicodeCategory { - UNICODE_SURROGATE = 1, /**< The surrogate Unicode category */ - UNICODE_MODIFIER, /**< The spacing modifier Unicode category */ - UNICODE_ARROW, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/ - UNICODE_SPACE, /**< The space Unicode category */ - UNICODE_PUNCTUATION, /**< The punctuation Unicode category */ - UNICODE_CONTROL, /**< The control Unicode category */ - UNICODE_MATH, /**< The math Unicode category */ - UNICODE_DIGIT, /**< The digit Unicode category */ - UNICODE_HANGUL, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/ - UNICODE_HANJA, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/ - UNICODE_COMBINING, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/ - UNICODE_LANGUAGE, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/ - UNICODE_UPPERCASE, /**< The uppercase Unicode category*/ - UNICODE_LOWERCASE, /**< The lowercase Unicode category*/ - UNICODE_TITLECASE, /**< The titlecase Unicode category*/ - UNICODE_LETTER, /**< The letter Unicode category*/ - UNICODE_MARK, /**< The mark Unicode category*/ - UNICODE_CURRENCY, /**< The currency Unicode category*/ - UNICODE_SEPARATOR, /**< The separator Unicode category*/ - UNICODE_OTHER /**< The other Unicode category */ + UNICODE_SURROGATE = 1, /**< The surrogate Unicode category */ + UNICODE_MODIFIER, /**< The spacing modifier Unicode category */ + UNICODE_ARROW, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */ + UNICODE_SPACE, /**< The space Unicode category */ + UNICODE_PUNCTUATION, /**< The punctuation Unicode category */ + UNICODE_CONTROL, /**< The control Unicode category */ + UNICODE_MATH, /**< The math Unicode category */ + UNICODE_DIGIT, /**< The digit Unicode category */ + UNICODE_HANGUL, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */ + UNICODE_HANJA, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */ + UNICODE_COMBINING, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */ + UNICODE_LANGUAGE, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */ + UNICODE_UPPERCASE, /**< The uppercase Unicode category */ + UNICODE_LOWERCASE, /**< The lowercase Unicode category */ + UNICODE_TITLECASE, /**< The titlecase Unicode category */ + UNICODE_LETTER, /**< The letter Unicode category */ + UNICODE_MARK, /**< The mark Unicode category */ + UNICODE_CURRENCY, /**< The currency Unicode category */ + UNICODE_SEPARATOR, /**< The separator Unicode category */ + UNICODE_OTHER /**< The other Unicode category */ }; @@ -67,9 +67,9 @@ enum UnicodeCategory * * @since 2.0 * - * The %Character class wraps a value of the @c wchar_t type. It also provides + * The %Character class wraps the value of the @c wchar_t type. It also provides * several methods for determining a Unicode character's category, and for - * converting the case of intrinsic characters. The class is useful when + * converting the case of the intrinsic characters. This class is useful when * passing a Unicode character to a method expecting an instance of Object. * * The following example demonstrates how to use the %Character class. @@ -80,7 +80,7 @@ enum UnicodeCategory * * using namespace Tizen::Base; * - * // This method converts the first character of the given @c string to the upper case. + * // This method converts the first character of the given string to the upper case. * void * MyClass::CharacterSample(String& str) * { @@ -104,7 +104,7 @@ public: * * @since 2.0 * - * @param[in] value A multi-byte character used to initialize the %Character instance + * @param[in] value The multi-byte character used to initialize the %Character instance */ Character(wchar_t value); @@ -113,7 +113,7 @@ public: * * @since 2.0 * - * @param[in] value An instance of %Character + * @param[in] value An instance of %Character to copy */ Character(const Character& value); @@ -129,7 +129,7 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %Character + * @param[in] rhs An instance of %Character to copy */ Character& operator =(const Character& rhs); @@ -139,8 +139,8 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value - * @param[in] value The character instance to compare with + * @return The 32-bit @c signed integer value + * @param[in] value The %Character instance to compare with * * @code * @li < 0 if the value of the current instance is less than the value of the input instance @@ -152,14 +152,14 @@ public: int CompareTo(const Character& value) const; /** - * Checks whether the value of the Object parameter is equal - * to the value of the calling object. + * Checks whether the value of the input Object is equal + * to the value of the calling %Object. * * @since 2.0 * @return @c true if the input Object is equal to the calling %Object, @n * else @c false - * @param[in] obj The object to compare with the calling object - * @see Tizen::Base::Object::Equals() + * @param[in] obj The object to compare with the calling object + * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Object& obj) const; @@ -169,30 +169,28 @@ 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, - * 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; /** - * Returns the value of the current instance as a - * @c wchar_t. + * Returns the value of the current instance as a @c wchar_t value. * * @since 2.0 * - * @return The value of this instance as - * a @c wchar_t + * @return The value of this instance as a @c wchar_t value */ wchar_t ToMchar(void) const; /** * @if OSPDEPREC * Converts the Unicode characters of the calling object to its equivalent lowercase. @n - * The Unicode characters other than English alphabets are not changed. + * Unicode characters other than the English alphabets are not changed. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the ToLowerCase() method that supports Unicode characters other than English alphabets. + * Instead of using this method, use the ToLowerCase() method that supports Unicode characters other than the English alphabets. * * @since 2.0 * @endif @@ -202,7 +200,7 @@ public: /** * Converts the Unicode characters of the calling object to its equivalent lowercase. @n - * The Unicode characters other than English alphabets are also supported. + * Unicode characters other than the English alphabets are also supported. * * @since 2.0 */ @@ -212,11 +210,11 @@ public: /** * @if OSPDEPREC * Converts the Unicode characters of the current object to its equivalent uppercase. @n - * The Unicode characters other than English alphabets are not changed. + * Unicode characters other than the English alphabets are not changed. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the ToUpperCase() method that supports the Unicode characters other than English alphabets. + * Instead of using this method, use the ToUpperCase() method that supports Unicode characters other than the English alphabets. * * @since 2.0 * @endif @@ -226,7 +224,7 @@ public: /** * Converts the Unicode characters of the current object to its equivalent uppercase. @n - * The Unicode characters other than English alphabets are also supported. + * Unicode characters other than English alphabets are also supported. * * @since 2.0 */ @@ -234,11 +232,11 @@ public: /** - * Returns a string representing the value of the calling %Character instance. + * Returns a string that represents the value of the calling %Character instance. * * @since 2.0 * - * @return An instance of String class that + * @return An instance of String that * contains a Unicode representation of the calling instance */ String ToString(void) const; @@ -249,7 +247,7 @@ public: * * @since 2.0 * - * @return An instance of the String class + * @return An instance of String * that contains the Unicode representation of the * input value * @param[in] value The Unicode character to convert @@ -257,12 +255,12 @@ public: static String ToString(wchar_t value); /** - * Categorizes a Unicode character into a group identified by + * Categorizes a Unicode character into a group that is identified by * one of the UnicodeCategory values. * * @since 2.0 * - * @return A value of type UnicodeCategory that identifies the group that contains the specified @c ch + * @return The value of type UnicodeCategory that identifies the group that contains the specified @c ch * @param[in] ch The Unicode character to categorize * */ @@ -271,14 +269,14 @@ public: /** * @if OSPDEPREC * Converts the input Unicode character to its equivalent lowercase. @n - * The Unicode characters other than English alphabets are not changed. + * Unicode characters other than the English alphabets are not changed. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the ToLowerCase(wchar_t ch) method that supports the Unicode characters other than English alphabets. + * Instead of using this method, use the ToLowerCase(wchar_t ch) method that supports Unicode characters other than the English alphabets. * * @since 2.0 - * @return An lowercase equivalent of the input Unicode character + * @return The lowercase equivalent of the input Unicode character * @param[in] ch The Unicode character to convert * @endif */ @@ -286,11 +284,11 @@ public: /** * Converts the input Unicode character to its equivalent lowercase. @n - * The Unicode characters other than English alphabets are also supported. + * Unicode characters other than the English alphabets are also supported. * * @since 2.0 * - * @return An lowercase equivalent of the input Unicode character + * @return The lowercase equivalent of the input Unicode character * @param[in] ch The Unicode character to convert */ static wchar_t ToLowerCase(wchar_t ch); @@ -298,14 +296,14 @@ public: /** * @if OSPDEPREC * Converts the input Unicode character to its equivalent uppercase. @n - * The Unicode characters other than English alphabets are not changed. + * Unicode characters other than the English alphabets are not changed. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the ToUpperCase(wchar_t ch) method that supports Unicode characters other than English alphabets. + * Instead of using this method, use the ToUpperCase(wchar_t ch) method that supports Unicode characters other than the English alphabets. * * @since 2.0 - * @return An uppercase equivalent of the input Unicode character + * @return The uppercase equivalent of the input Unicode character * @param[in] ch The Unicode character to convert * @endif */ @@ -313,18 +311,18 @@ public: /** * Converts the input Unicode character to its equivalent uppercase. @n - * The Unicode characters other than English alphabets are also supported. + * Unicode characters other than the English alphabets are also supported. * * @since 2.0 * - * @return An uppercase equivalent of the input Unicode character + * @return The uppercase equivalent of the input Unicode character * @param[in] ch The Unicode character to convert */ static wchar_t ToUpperCase(wchar_t ch); /** * Checks whether the input character is an alphanumeric character (letter or digit). @n - * A character is considered to be an alphanumeric character if either Character::isLetter(wchar_t ch) or Character::isDigit(wchar_t ch) returns true for the character + * A character is considered to be an alphanumeric character if either Character::isLetter(wchar_t ch) or Character::isDigit(wchar_t ch) returns @c true for the character * @if OSPCOMPAT * @brief [Compatibility] * @endif @@ -345,11 +343,11 @@ public: * @section CompCharacterIsAlphaNumericPageIssueSection Issues * Implementing this method in OSP compatible applications has the following issues: @n * - * -# The method returns true only if the character is alphabet character and cannot checks other Unicode character in Letter and digit category. + * -# The method returns @c true only if the character is an alphabet character, it cannot check other Unicode characters in the letter and digit category. * * @section CompCharacterIsAlphaNumericPageSolutionSection Resolutions * - * This issue has been resolved in Tizen. + * This issue mentioned above is resolved in %Tizen. * @endif */ @@ -387,11 +385,11 @@ public: * @section CompCharacterIsLetterPageIssueSection Issues * Implementing this method in OSP compatible applications has the following issues: @n * - * -# The method returns true only if the character is alphabet character and cannot checks other Unicode character in Letter category. + * -# The method returns @c true only if the character is an alphabet character, it cannot check other Unicode characters in the letter category. * * @section CompCharacterIsLetterPageSolutionSection Resolutions * - * This issue has been resolved in Tizen. + * This issue mentioned above is resolved in %Tizen. * @endif */ @@ -399,12 +397,12 @@ public: * @if OSPDEPREC * Checks whether the input character is a lowercase alphabet. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the IsLowerCase(wchar_t ch) method that supports Unicode characters. + * Instead of using this method, use the IsLowerCase(wchar_t ch) method that supports Unicode characters. * @since 2.0 * - * @return @c true if the input character is a lowercase English alphabet, @n + * @return @c true if the input character is a lowercase alphabet, @n * else @c false * @param[in] ch The Unicode character * @endif @@ -427,9 +425,9 @@ public: * @if OSPDEPREC * Checks whether the input character is an uppercase alphabet. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the IsUpperCase(wchar_t ch) method that also supports Unicode characters other than English alphabets. + * Instead of using this method, use the IsUpperCase(wchar_t ch) method that also supports Unicode characters other than the English alphabets. * @since 2.0 * * @return @c true if the input character is an uppercase alphabet, @n @@ -452,38 +450,39 @@ public: static bool IsUpperCase(wchar_t ch); /** - * Returns the value of the input character in the supplied radix. @n - * The value of radix must be between RADIX_MIN and RADIX_MAX. + * Returns the value of the input character in the supplied @c radix. @n + * The value of @c radix must be between ::RADIX_MIN and ::RADIX_MAX. * * @since 2.0 * - * @return A integer value of the input character in the supplied radix - * @param[in] ch The character to determine the value + * @return The integer value of the input character in the supplied @c radix + * @param[in] ch The character that determines the value * @param[in] radix The radix */ static int ToDigit(wchar_t ch, int radix); /** - * Returns the value which represents the input digit with specified radix. @n - * The value of radix must be between RADIX_MIN and RADIX_MAX. + * Returns the value which represents the input digit in the specified @c radix. @n + * The value of @c radix must be between ::RADIX_MIN and ::RADIX_MAX. * * @since 2.0 * - * @return A Unicode character of the input digit with specified @c radix @n - * else @c null character (U+0000) - * @param[in] digit The digit to determine the value + * @return The Unicode character of the input digit in the specified @c radix @n + * else a @c null character (U+0000) + * @param[in] digit The digit that determines the value * @param[in] radix The radix */ static wchar_t ForDigit(int digit, int radix); /** * Gets the numeric value of the input unicode character. @n - * This is used when some numeric values are fractions, negative, or too large for @c int value. + * This is used when some numeric values are fractions, negative, or too large for the @c int value. * * @since 2.0 * - * @return A @c double value @n NO_NUMERIC_VALUE for characters without any numeric values in the Unicode %Character. - * @param[in] ch A Unicode character + * @return The @c double value @n + * NO_NUMERIC_VALUE is returned for characters without any numeric values in the Unicode character. + * @param[in] ch The Unicode character */ static double GetNumericValue(wchar_t ch); @@ -494,7 +493,7 @@ public: * * @return @c true if the Unicode character is an assigned character, @n * else @c false - * @param[in] ch A Unicode character + * @param[in] ch The Unicode character */ static bool IsDefined(wchar_t ch); @@ -506,10 +505,10 @@ public: * * @return @c true if the Unicode character is a whitespace character, @n * else @c false - * @param[in] ch A Unicode character + * @param[in] ch The Unicode character * * @code - * It is a Unicode Separator character, but is not also a non-breaking space (U+00A0 NBSP or U+2007 Figure Space or U+202F Narrow NBSP). + * It is a Unicode Separator character, but is also not a non-breaking space (U+00A0 NBSP or U+2007 Figure Space or U+202F Narrow NBSP). * It is U+0009 HORIZONTAL TABULATION. * It is U+000A LINE FEED. * It is U+000B VERTICAL TABULATION. @@ -531,7 +530,7 @@ public: * * @return @c true if the Unicode character is a title character, @n * else @c false - * @param[in] ch A Unicode character + * @param[in] ch The Unicode character */ static bool IsTitleCase(wchar_t ch); @@ -540,19 +539,20 @@ public: * * @since 2.0 * - * @return A title case character equivalent for the input character @n The character itself is returned if none is defined. - * @param[in] ch A Unicode character + * @return The title case character equivalent for the input character @n + * The character itself is returned if no equivalent is defined. + * @param[in] ch The Unicode character */ static wchar_t ToTitleCase(wchar_t ch); /** - * Checks whether the input character is an ISO control code or not. + * Checks whether the input character is an ISO control code. * * @since 2.0 * * @return @c true if the Unicode character is an ISO control character, @n * else @c false - * @param[in] ch A Unicode character + * @param[in] ch The Unicode character */ static bool IsISOControl(wchar_t ch); @@ -565,57 +565,57 @@ public: static const wchar_t VALUE_MAX = 0x10FFFF; /** - * A constant holding the smallest value of type wchar_t, 0x0000. + * A constant holding the smallest value of type @c wchar_t, 0x0000. * * @since 2.0 */ static const wchar_t VALUE_MIN = 0x0000; /** - * The minimum radix available for conversion to and from strings. @n - * Same value as RADIX_BINARY. + * The minimum radix available for converting to and from strings. @n + * Same value as ::RADIX_BINARY. * * @since 2.0 */ static const int RADIX_MIN = 2; /** - * The radix for binary number. + * The radix for a binary number. * * @since 2.0 */ static const int RADIX_BINARY = 2; /** - * The radix for decimal number. + * The radix for a decimal number. * * @since 2.0 */ static const int RADIX_DECIMAL = 10; /** - * The radix for octal number. + * The radix for an octal number. * * @since 2.0 */ static const int RADIX_OCTAL = 8; /** - * The radix for hexadecimal number. + * The radix for a hexadecimal number. * * @since 2.0 */ static const int RADIX_HEXADECIMAL = 16; /** - * The maximum radix available for conversion to and from strings. Same value as RADIX_HEXADECIMAL. + * The maximum radix available for converting to and from strings. Same value as ::RADIX_HEXADECIMAL. * * @since 2.0 */ static const int RADIX_MAX = 36; /** - * Special value that is returned by GetNumericValue(wchar_t ch) when no numeric value is defined for the unicode character. + * The special value that is returned by the GetNumericValue(wchar_t ch) method when no numeric value is defined for the unicode character. * * @since 2.0 */ diff --git a/inc/FBaseCol.h b/inc/FBaseCol.h index 00bf0ac..692343e 100644 --- a/inc/FBaseCol.h +++ b/inc/FBaseCol.h @@ -54,12 +54,12 @@ * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * * The %Collection namespace contains classes and interfaces for various collections * (such as lists, maps, stacks, and queues), which are an aggregation of similar objects. * - * For more information on the %Base::Collection namespace features, see Collection. + * For more information on the %Collection namespace features, see Collection. * * The following diagrams illustrate the relationships between the classes belonging to the %Collection namespace. * diff --git a/inc/FBaseColAllElementsDeleter.h b/inc/FBaseColAllElementsDeleter.h index 9dfb600..dad0b70 100644 --- a/inc/FBaseColAllElementsDeleter.h +++ b/inc/FBaseColAllElementsDeleter.h @@ -27,9 +27,9 @@ namespace Tizen { namespace Base { namespace Collection { /** * @struct AllElementsDeleter - * @brief This function object provides a resource clean-up function for collection. + * @brief This function object provides a resource clean-up function for a collection. * - * The %AllElementsDeleter struct provides a resource clean-up function for collection. This can be used with unique_ptr as a custom deleter. + * The %AllElementsDeleter struct provides a resource clean-up function for a collection. This can be used with unique_ptr as a custom deleter. * * @since 2.0 */ @@ -41,7 +41,7 @@ struct AllElementsDeleter * @since 2.0 * * @param[in] c The collection to clean up - * @remarks The collection should be destructible and support the RemoveAll(bool) method. + * @remarks The collection should be destructible and should support the RemoveAll(bool) method. * IList, IMap, and IMultiMap support this concept. */ template< typename Collection > diff --git a/inc/FBaseColArrayList.h b/inc/FBaseColArrayList.h index 9734cc9..5404c1f 100644 --- a/inc/FBaseColArrayList.h +++ b/inc/FBaseColArrayList.h @@ -113,11 +113,14 @@ public: * * @since 2.0 * - * @param[in] deleter The function pointer to type of the element deleter - * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n - * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter. - * It means that you do not transfer the ownership of elements to the collection. - * @remarks After creating an instance of the %ArrayList class, one of the Construct() methods must be called explicitly to initialize this instance. + * @param[in] deleter A function pointer to the type of the element deleter + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection will destroy the elements. @n + * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * It means that you do not transfer the ownership of the elements to the collection. + * - After creating an instance of the %ArrayList class, one of the Construct() methods must be called explicitly to initialize this instance. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -138,13 +141,14 @@ public: * @since 2.0 * * @return An error code - * @param[in] capacity The number of elements @n - * The default capacity is @c 10. + * @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 A specified input parameter is invalid, or - * the specified @c capacity is negative. - * @remarks If the number of elements added to the list reaches the current capacity, - * the capacity is automatically increased by memory reallocation. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity is negative. + * @remarks If the number of elements added to the list reaches the current capacity, + * the capacity is automatically increased by memory reallocation. @n * Therefore, if the size of the list can be estimated, * specifying the initial capacity eliminates the need to perform a number of * resizing operations while adding elements to the list. @@ -161,11 +165,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection A collection to add + * @param[in] collection The collection to add * @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 ArrayList() */ result Construct(const ICollection& collection); @@ -176,10 +181,10 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj An pointer to object to add + * @param[in] pObj A pointer to the object to add * @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 adds just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself. * @see Remove() */ virtual result Add(Object* pObj); @@ -191,38 +196,39 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection A collection to add + * @param[in] collection The collection to add * @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 adds 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 RemoveItems() */ virtual result AddItems(const ICollection& collection); /** - * Gets an enumerator (an instance of the IEnumerator-derived class) of this list. + * Gets the enumerator (an instance of the IEnumerator derived class) of this list. * * @since 2.0 * - * @return An instance of the IEnumerator-derived class, @n - * else @c null if some exception occurs + * @return An instance of the IEnumerator derived class, @n + * else @c null if an exception occurs * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual IEnumerator* GetEnumeratorN(void) const; /** - * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list. + * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list. * * @since 2.0 * * @return An instance of the IBidirectionalEnumerator derived class, @n - * else @c null if some exception occurs - * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) + * else @c null if an exception occurs + * @remarks + * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) * to iterate over a collection (an instance of the IList derived class). - * The specific error code can be accessed using GetLastResult() method. - * @see Tizen::Base::Collection::IBidirectionalEnumerator + * - The specific error code can be accessed using GetLastResult() method. */ virtual IBidirectionalEnumerator* GetBidirectionalEnumeratorN(void) const; @@ -232,11 +238,13 @@ public: * @since 2.0 * * @return The object at the specified @c index of this list, @n - * else @c null if the index is not valid - * @param[in] index The index of the object in the calling list to read + * else @c null if the @c index is not valid + * @param[in] index The index of the object to read in the calling list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either equal to or greater than the number of elements. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetAt() */ @@ -249,103 +257,110 @@ public: * @since 2.0 * * @return The object at the specified @c index of this list, @n - * else @c null if the index is not valid - * @param[in] index The index of the object to read + * else @c null if the @c index is not valid + * @param[in] index The index of the object to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either equal to or greater than the number of elements. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetAt() */ virtual Object* GetAt(int index); /** - * Gets the IList within the specified range of this list. + * Gets an IList instance within the specified range of this list. * * @since 2.0 * * @return A pointer to IList, @n - * else @c null if some exception occurs - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read + * else @c null if an exception occurs + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. - * @remarks The IList stores just the pointers to the elements in the list, not the elements themselves. - * The specific error code can be accessed using the GetLastResult() method. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c startIndex is either equal to or greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @remarks + * - The IList stores only the pointers to the elements in the list, not the elements themselves. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IList* GetItemsN(int startIndex, int count) const; /** * Searches for an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int& index) const; /** - * Searches for an object starting from the specified index. @n - * Gets the index of the object if found. + * Searches for an object starting from the specified @c startIndex. @n + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index for the search @n - * It must be less than the number of elements. - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index for the search @n + * It must be less than the number of elements. + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either equal to or greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int startIndex, int& index) const; /** * Searches for an object within the specified range. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either equal to or greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int startIndex, int count, int& index) const; /** * Searches for the last occurrence of an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the last occurrence of the specified object + * @param[in] obj The object to locate + * @param[out] index The index of the last occurrence of the specified object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see IndexOf() */ virtual result LastIndexOf(const Object& obj, int& index) const; @@ -356,16 +371,19 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to insert - * @param[in] index The index at which the object must be inserted + * @param[in] pObj A pointer to the object to insert + * @param[in] index The index at which the object is inserted * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is greater than the number of elements or less than @c 0. - * @remarks The elements that follow the insertion point move down to accommodate the new element. - * If the @c index equals to the number of elements, then the new element + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements. + * - The specified @c index is less than @c 0. + * @remarks + * - The elements that follow the insertion point move down to accommodate the new element. + * - If the @c index is equal to the number of elements, then the new element * is added at the end of this list. - * This method performs a shallow copy. It inserts just the pointer; not the element itself. + * - This method performs a shallow copy. It inserts just the pointer and not the element itself. * @see Add() * @see RemoveAt() */ @@ -377,17 +395,21 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to insert - * @param[in] startIndex The starting index at which the collection must be inserted + * @param[in] collection The collection to insert + * @param[in] startIndex The starting index at which the collection is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c startIndex is greater than the number of elements or less than @c 0. - * @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 The elements that follow the insertion point move down to accommodate the new element. - * If the @c startIndex equals to the number of elements then the new elements + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c startIndex is greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * @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 elements that follow the insertion point move down to accommodate the new element. + * - If the @c startIndex is equal to the number of elements then the new elements * are added at the end of this list. - * This method performs a shallow copy. It inserts just the pointer; not the element itself. + * - This method performs a shallow copy. It inserts just the pointer and not the element itself. * @see RemoveItems() * @see AddItems() */ @@ -399,9 +421,9 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj An object to remove + * @param[in] obj The object to remove * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see Add() * @see RemoveAt() * @see RemoveAll() @@ -414,10 +436,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index at which the object must be removed + * @param[in] index The index at which the object is removed * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either equal to or greater than the number of elements. + * - The specified @c index is less than @c 0. * @remarks The elements that follow the deletion point move up to occupy the vacated spot. * @see InsertAt() * @see Remove() @@ -430,14 +454,15 @@ public: * @since 2.0 * * @return An error code - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c startIndex is either equal to or greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * @remarks The elements that follow the deletion point move up to occupy the vacated spot. * @see AddItems() */ @@ -452,15 +477,16 @@ public: * @return An error code * @param[in] collection The collection to remove from this list * @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. * @see Remove() * @see RemoveAt() */ virtual result RemoveItems(const ICollection& collection); /** - * Removes all of the object pointers in the collection and also removes all of the objects depending on the specified element deleter. + * Removes all the object pointers in the collection and also removes all the objects depending on the specified element deleter. * The %RemoveAll() can be called before the collection is deleted. * * @since 2.0 @@ -473,26 +499,29 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj An pointer to object to set - * @param[in] index The index at which the object must be set + * @param[in] pObj A pointer to the object to set + * @param[in] index The index at which the object is set * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements or less than @c 0. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either equal to or greater than the number of elements. + * - The specified @c index is less than @c 0. * @see GetAt() */ virtual result SetAt(Object* pObj, int index); /** - * Sets the capacity of this list to the specified value. + * Sets the capacity of this list at the specified value. * * @since 2.0 * * @return An error code - * @param[in] newCapacity The new capacity of this list + * @param[in] newCapacity The new capacity of this list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the @c newCapacity is negative. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c newCapacity is negative. * @remarks When the new capacity is less than the current capacity, the elements * within the truncated memory are not destroyed. * @see Construct() @@ -502,7 +531,7 @@ public: virtual result SetCapacity(int newCapacity); /** - * Sorts the elements of this list using the comparer provided. + * Sorts the elements of this list using the @c comparer provided. * * @since 2.0 * @@ -540,13 +569,13 @@ public: virtual int GetCount(void) const; /** - * Checks whether a list contains the specified object. + * Checks whether the list contains the specified object. * * @since 2.0 * * @return @c true if the object is present in the list, @n * else @c false - * @param[in] obj The object to locate + * @param[in] obj The object to locate * @see ContainsAll() */ virtual bool Contains(const Object& obj) const; @@ -558,26 +587,28 @@ public: * * @return @c true if the list contains all the elements of the specified @c collection, @n * else @c false - * @param[in] collection The collection to check for in the list + * @param[in] collection The collection to check for in the list * @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 The specific error code can be accessed using the GetLastResult() method. - * @remarks If the given @c collection is empty, this method will return @c true. + * @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. + * - If the given @c collection is empty, this method will return @c true. * @see Contains() */ virtual bool ContainsAll(const ICollection& collection) const; /** - * Compares the specified Object instance with the calling %ArrayList instance. + * Compares the specified Tizen::Base::Object instance with the calling %ArrayList instance. * * @since 2.0 * - * @return @c true if the given object matches the calling List, @n + * @return @c true if the given Tizen::Base::Object matches the calling list, @n * else @c false * @param[in] obj The object to compare with the calling list - * @remarks This method returns @c true only if the specified object @c obj is also an instance of %ArrayList class, - * both lists have the same size, and all the corresponding pairs of the elements in the two lists are equal. + * @remarks This method returns @c true only if the specified @c obj is also an instance of %ArrayList, + * both lists have the same size, and all the corresponding pairs of the elements in the two lists are equal. @n * In other words, the two lists are equal if they contain the same elements in the same order. */ virtual bool Equals(const Object& obj) const; @@ -588,13 +619,13 @@ 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; /** - * Distinguish between %ArrayList and LinkedList. + * Checks whether the instance is an %ArrayList or a LinkedList. * * @since 2.0 * @return @c true if it is an %ArrayList, @n diff --git a/inc/FBaseColArrayListT.h b/inc/FBaseColArrayListT.h index a687295..425d42d 100644 --- a/inc/FBaseColArrayListT.h +++ b/inc/FBaseColArrayListT.h @@ -138,10 +138,11 @@ public: * @param[in] capacity The initial capacity of the class @n * The default capacity is @c 10. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c capacity is negative. - * @remarks If the number of elements added to the list reaches its 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 list reaches its current capacity, + * the capacity is automatically increased by memory reallocation. @n * Thus, if the size of the list can be estimated, * specifying the initial capacity eliminates the need to perform a number of * resizing operations while adding elements to the list. @@ -164,10 +165,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection A collection of elements to add + * @param[in] collection The collection of elements to add * @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. * @see ArrayListT() */ result Construct(const ICollectionT< Type >& collection) @@ -185,12 +187,12 @@ CATCH: } /** - * Adds the specified object to the end of the list. + * Adds the specified @c obj to the end of the list. * * @since 2.0 * * @return An error code - * @param[in] obj An object to add to the list + * @param[in] obj The object to add to the list * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @see Remove() @@ -211,15 +213,16 @@ CATCH: } /** - * Adds the elements of the specified collection to the end of the list. + * Adds the elements of the specified @c collection to the end of the list. * * @since 2.0 * * @return An error code - * @param[in] collection A collection of elements to add to the list + * @param[in] collection The collection of elements to add to the list * @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. * @see RemoveItems() */ virtual result AddItems(const ICollectionT< Type >& collection) @@ -263,16 +266,15 @@ CATCH: } /** - * Gets the elements of the list in an instance of the IEnumeratorT derived class. + * Gets the elements of the list through an instance of the IEnumeratorT derived class. * * @since 2.0 * - * @return An instance of the IEnumeratorT derived class if successful, @n + * @return An instance of the IEnumeratorT derived class, @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 { @@ -290,7 +292,7 @@ CATCH: } /** - * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list. + * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list. * * @since 2.0 * @@ -298,10 +300,10 @@ CATCH: * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) + * @remarks + * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) * to iterate over a collection (an instance of the IListT derived class). - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IBidirectionalEnumeratorT + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IBidirectionalEnumeratorT< Type >* GetBidirectionalEnumeratorN(void) const { @@ -325,10 +327,12 @@ CATCH: * * @return An error code * @param[in] index The index of the object to read - * @param[out] obj An object to get from this list + * @param[out] obj The object to get from this list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see SetAt() */ virtual result GetAt(int index, Type& obj) const @@ -348,10 +352,12 @@ CATCH: * * @return An error code * @param[in] index The index of the object to read - * @param[out] obj An object to get from this list + * @param[out] obj The object to get from this list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see SetAt() */ virtual result GetAt(int index, Type& obj) @@ -365,20 +371,22 @@ CATCH: } /** - * Gets a list of a specified number of elements starting from a specified index. + * Gets a list of the specified number of elements starting from the specified index. * * @since 2.0 * * @return An instance of the IListT derived class within the specified range of the list, @n * else @c null if an exception occurs - * @param[in] startIndex The index to start reading elements from - * @param[in] count The number of elements to read + * @param[in] startIndex The index to start reading elements from + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either greater than or equal to the number of elements or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -416,15 +424,15 @@ CATCH: /** * Searches for an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int& index) const @@ -434,19 +442,21 @@ CATCH: /** * Searches for an object starting from the specified @c index. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index for the search @n - * It must be less than the number of elements. - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index for the search @n + * It must be less than the number of elements. + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int startIndex, int& index) const @@ -460,21 +470,23 @@ CATCH: /** * Searches for an object within the specified range. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified @c index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either greater than or equal to the number of elements or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int startIndex, int count, int& index) const @@ -501,18 +513,21 @@ CATCH: } /** - * Inserts an object at a specified location. + * Inserts an object at the specified location. * * @since 2.0 * * @return An error code - * @param[in] obj The object to insert - * @param[in] index The index at which the object must be inserted + * @param[in] obj The object to insert + * @param[in] index The index at which the object is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the @c index is greater than the number of elements or less than @c 0. - * @remarks The elements that follow the insertion point move down to accommodate the new element. - * If the @c index equals the number of elements in the list, the new element + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements. + * - The specified @c index is less than @c 0. + * @remarks + * - The elements that follow the insertion point move down to accommodate the new element. + * - If the @c index is equal to the number of elements in the list, the new element * is added at the end of the list. * @see Add() * @see RemoveAt() @@ -544,20 +559,24 @@ CATCH: } /** - * Inserts the elements of a collection at a specified location. + * Inserts the elements of the collection from a specified location. * * @since 2.0 * * @return An error code - * @param[in] collection The collection to insert - * @param[in] startIndex The index from which the collection must be inserted + * @param[in] collection The collection to insert + * @param[in] startIndex The index from which the collection is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c startIndex is greater than the number of elements or less than @c 0. - * @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 The elements that follow the insertion point move down to accommodate the new elements. - * If the @c startIndex equals the number of elements in the list, the new elements + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * @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 elements that follow the insertion point move down to accommodate the new elements. + * - If the @c startIndex is equal to the number of elements in the list, the new elements * are added at the end of the list. * @see RemoveItems() * @see AddItems() @@ -616,15 +635,15 @@ CATCH: /** * Searches for the last occurrence of an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the last occurrence of the specified object + * @param[in] obj The object to locate + * @param[out] index The index of the last occurrence of the specified object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see IndexOf() */ virtual result LastIndexOf(const Type& obj, int& index) const @@ -642,14 +661,14 @@ CATCH: } /** - * Removes the first occurrence of a specified object. + * Removes the first occurrence of the specified object. * * @since 2.0 * * @return An error code * @param[in] obj The object to remove * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see Add() * @see RemoveAt() * @see RemoveAll() @@ -669,15 +688,16 @@ CATCH: } /** - * Removes all the elements of a specified collection from the list. + * Removes all the elements of the specified collection from the list. * * @since 2.0 * * @return An error code * @param[in] collection The collection to remove from this list * @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. * @see Remove() * @see RemoveAt() */ @@ -717,15 +737,17 @@ CATCH: } /** - * Removes an object from a specified location. + * Removes an object from the specified location. * * @since 2.0 * * @return An error code - * @param[in] index The index of the object that is to remove + * @param[in] index The index of the object to remove * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the specified @c index is greater than or equal to the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @remarks The elements that follow the deleted object move up the list to occupy the empty location. * @see InsertAt() * @see Remove() @@ -750,18 +772,20 @@ CATCH: } /** - * Removes all the elements within a specified range. + * Removes all the elements within the specified range. * * @since 2.0 * * @return An error code - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to remove + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to remove * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either greater than or equal to the number of elements or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * @remarks The elements that follow the deleted elements move up the list to occupy the empty locations. * @see AddItems() * @see InsertItemsFrom() @@ -801,7 +825,7 @@ CATCH: } /** - * Removes all elements in the list. + * Removes all the elements in the list. * * @since 2.0 */ @@ -821,16 +845,18 @@ CATCH: } /** - * Sets the object at a specified @c index of the current instance of ByteBuffer with the specified object. + * Sets the object at the specified @c index of the current instance of ByteBuffer. * * @since 2.0 * * @return An error code - * @param[in] obj The object to set - * @param[in] index The index at which the object must be set + * @param[in] obj The object to set + * @param[in] index The index at which the object must be set * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see GetAt() */ virtual result SetAt(const Type& obj, int index) @@ -847,15 +873,16 @@ CATCH: } /** - * Sets the capacity of the list to a specified value. + * Sets the capacity of the list at the specified value. * * @since 2.0 * * @return An error code * @param[in] newCapacity The new capacity to set for the list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c newCapacity is negative. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c newCapacity is negative. * @remarks If the new capacity is less than the current capacity, the memory * is truncated and the elements within the truncated memory are destroyed. * @see Construct() @@ -912,8 +939,9 @@ CATCH: * @return An error code * @param[in] comparer A pointer to IComparerT * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c comparer is not valid. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c comparer is invalid. */ virtual result Sort(const IComparerT< Type >& comparer) { @@ -934,13 +962,13 @@ CATCH: } /** - * Trims the capacity of a list to the actual number of elements in the list. + * Trims the capacity of the list to the actual number of elements in the list. * * @since 2.0 * * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @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 SetCapacity() */ @@ -984,13 +1012,13 @@ CATCH: } /** - * Checks whether a list contains the specified object. + * Checks whether the list contains the specified object. * * @since 2.0 * * @return @c true if the object is present in the list, @n * else @c false - * @param[in] obj The object to locate + * @param[in] obj The object to locate * @see ContainsAll() */ virtual bool Contains(const Type& obj) const @@ -1017,13 +1045,14 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] collection The collection to check for in the list - * @param[out] out @c true if the list contains all the elements of the specified @c collection, @n - * else @c false + * @param[in] collection The collection to check in the list + * @param[out] out @c true if the list contains all the elements of the specified @c 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. - * @remarks If the given @c collection is empty, the @c out parameter will be set to @c true. + * @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 If the given @c collection is empty, then @c out is set to @c true. * @see Contains() */ virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const @@ -1072,7 +1101,7 @@ CATCH: } /** - * Compares two instances of the %ArrayListT class. + * Compares two instances of %ArrayListT. * * @since 2.0 * @@ -1116,8 +1145,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 { diff --git a/inc/FBaseColHashMap.h b/inc/FBaseColHashMap.h index d7b99c2..cf1434d 100644 --- a/inc/FBaseColHashMap.h +++ b/inc/FBaseColHashMap.h @@ -43,7 +43,7 @@ class _HashMapEntry; * * For more information on the class features, see HashMap and MultiHashMap. * - * The following example demonstrates how to use the %HashMap class to create and initialize a %HashMap instance and to use its methods. + * The following example demonstrates how to use the %HashMap class to create and initialize a %HashMap instance and use its methods. * * @code * @@ -104,10 +104,11 @@ public: * * @since 2.0 * - * @param[in] deleter The function pointer to type of the element deleter - * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n - * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter. - * It means that you do not transfer the ownership of elements to the collection. + * @param[in] deleter A function pointer to the type of the element deleter + * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection, the ownership of the elements and the collection destroys the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, as @c NoOpDeleter is the default element deleter. + * It means that you do not transfer the ownership of the elements to the collection. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -122,7 +123,7 @@ public: virtual ~HashMap(void); /** - * Initializes an instance of an empty %HashMap class with the initial capacity and load factor. + * Initializes an instance of the empty %HashMap with the initial @c capacity and the load factor. * * @since 2.0 * @@ -130,34 +131,37 @@ public: * @param[in] capacity The initial capacity * @param[in] loadFactor The maximum ratio of elements to buckets * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, @n - * the @c capacity or the @c loadFactor is negative. - * @remarks The GetHashCode() method of key objects is used for hashing and - * the Equals() method of key objects is used for comparing keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity or the specified @c loadFactor is negative. + * @remarks The GetHashCode() method of the key objects is used for hashing and + * the Equals() method of the key objects is used for comparing the keys. * @see HashMap() */ result Construct(int capacity = 16, float loadFactor = 0.75); /** - * Initializes an instance of a %HashMap class by copying the elements of the specified @c map. + * Initializes an instance of %HashMap by copying the elements of the specified @c map. * * @since 2.0 * * @return An error code - * @param[in] map The map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c loadFactor is negative. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map is modified during the operation of this method. - * @remarks This method performs a shallow copy. It copies only the pointer; not the element itself. + * @param[in] map The map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c loadFactor is negative. + * @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 map 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 HashMap() */ result Construct(const IMap& map, float loadFactor = 0.75); /** - * Initializes an instance of an empty %HashMap class with the specified initial capacity, load factor, hash code provider, and comparer. + * Initializes an instance of the empty %HashMap with the specified initial capacity, load factor, hash code provider, and comparer. * * @since 2.0 * @@ -170,67 +174,71 @@ public: * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys * * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c capacity or the @c loadFactor is negative. - * @remarks The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity or the specified @c loadFactor is negative. + * @remarks The instances of the hash code provider and the comparer are not deallocated later from this map. * @see HashMap() */ result Construct(int capacity, float loadFactor, const IHashCodeProvider& provider, const IComparer& comparer); /** - * Initializes an instance of a %HashMap class by copying the elements of the specified map with the specified load factor, hash code provider, and comparer. + * Initializes an instance of %HashMap by copying the elements of the specified map with the specified load factor, hash code provider, and comparer. * * @since 2.0 * * @return An error code - * @param[in] map The map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor(0.75) is used. - * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes for all keys in this map - * @param[in] comparer An instance of the IComparer derived class to use when comparing keys + * @param[in] map The map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor(0.75) is used. + * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes for all the keys in this map + * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c loadFactor is negative. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map is modified during the operation of this method. - * @remarks This method performs a shallow copy. It copies only the pointer; not the element itself. - * @remarks The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c loadFactor is negative. + * @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 map 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. + * - The instances of the hash code provider and the comparer are not deallocated later from this map. * @see HashMap() */ result Construct(const IMap& map, float loadFactor, const IHashCodeProvider& provider, const IComparer& comparer); /** - * Adds the specified key-value pair to a map. + * Adds the specified key-value pair to the map. * * @since 2.0 * * @return An error code - * @param[in] pKey The pointer to key of the value to add - * @param[in] pValue The pointer to value to add + * @param[in] pKey A pointer to the key of the value to add + * @param[in] pValue A pointer to the value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_ALREADY_EXIST The specified @c pKey already exists. - * @remarks This method performs a shallow copy. It adds only the pointer; not the element itself. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Remove() */ virtual result Add(Object* pKey, Object* pValue); /** - * Gets an enumerator (an instance of the IMapEnumerator derived class) of this map. + * Gets the enumerator (an instance of the IMapEnumerator derived class) of this map. * * @since 2.0 * - * @return An instance of the IMapEnumerator derived class, if successful @n + * @return An instance of the IMapEnumerator derived class, @n * else @c null if an exception occurs * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Base::Collection::IEnumerator - * @see Tizen::Base::Collection::IMapEnumerator */ virtual IEnumerator* GetEnumeratorN(void) const; /** - * Gets the elements of the map in an instance of the IMapEnumerator derived class. + * Gets the elements of the map through an instance of the IMapEnumerator derived class. * * @since 2.0 * @@ -238,55 +246,56 @@ public: * else @c null if an exception occurs * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Base::Collection::IEnumerator - * @see Tizen::Base::Collection::IMapEnumerator */ virtual IMapEnumerator* GetMapEnumeratorN(void) const; /** - * Gets the value associated with the specified @c key. + * Gets the value associated to the specified @c key. * * @since 2.0 * - * @return The value associated with the key, @n + * @return The value associated to the key, @n * else @c null if an exception occurs - * @param[in] key The key to locate + * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetValue() */ virtual const Object* GetValue(const Object& key) const; /** - * Gets the value associated with the specified @c key. + * Gets the value associated to the specified @c key. * * @since 2.0 * - * @return The value associated with the key, @n + * @return The value associated to the key, @n * else @c null if an exception occurs - * @param[in] key The key to locate + * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetValue() */ virtual Object* GetValue(const Object& key); /** - * Gets a list of all the keys in a map. + * Gets the list of all the keys in the map. * * @since 2.0 * - * @return A pointer to an IList object containing all the keys in the map, @n + * @return A pointer to the IList object containing all the keys in the map, @n * else @c null if an exception occurs - * @remarks The order of the keys is the same as the corresponding values in the IList interface returned by the GetValuesN() method. - * The IList stores just the pointers to the elements in the map, not the elements themselves. - * The specific error code can be accessed using the GetLastResult() method. - * @see GetValuesN() + * @remarks + * - The order of the keys is the same as the corresponding values in the IList interface returned by the GetValuesN() method. + * - The IList stores just the pointers to the elements in the map and not the elements themselves. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IList* GetKeysN(void) const; @@ -295,25 +304,27 @@ public: * * @since 2.0 * - * @return A pointer to an IList object containing all the values in the map, @n + * @return A pointer to the IList object that contains all the values in the map, @n * else @c null if an exception occurs - * @remarks The IList stores just the pointers to the elements in the map, not the elements themselves. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The IList stores just the pointers to the elements in the map and not the elements themselves. + * - The specific error code can be accessed using the GetLastResult() method. * @see GetKeysN() */ virtual IList* GetValuesN(void) const; /** - * Removes the values associated with the specified @c key. + * Removes the values associated to the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key to remove + * @param[in] key The key to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add() */ virtual result Remove(const Object& key); @@ -327,19 +338,19 @@ public: virtual void RemoveAll(void); /** - * Sets the value associated with the specified @c key by allocating it a new value. + * Sets the value associated to the specified @c key by allocating a new value to it. * * @since 2.0 * * @return An error code - * @param[in] key The key whose value is to replace - * @param[in] pValue The pointer to new value to replace + * @param[in] key The key whose value is replaced + * @param[in] pValue A pointer to the new value to replace * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks To add a new key-value pair, use the Add() method. - * @see Add() * @see GetValue() */ virtual result SetValue(const Object& key, Object* pValue); @@ -360,10 +371,11 @@ public: * * @return @c true if the map contains the specified @c key, @n * else @c false - * @param[in] key The key to locate + * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see ContainsValue() */ @@ -383,14 +395,14 @@ public: virtual bool ContainsValue(const Object& value) const; /** - * Compares two instances of the %HashMap class. + * Compares two instances of %HashMap. * * @since 2.0 * * @return @c true if the two instances match, @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 two instances contain the same number of elements and all the elements contained in each other. + * @remarks This method returns @c true if and only if the two instances contain the same number of elements and all the elements are present in both of them. */ virtual bool Equals(const Object& obj) const; @@ -400,8 +412,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; diff --git a/inc/FBaseColHashMapT.h b/inc/FBaseColHashMapT.h index e731325..35751e4 100644 --- a/inc/FBaseColHashMapT.h +++ b/inc/FBaseColHashMapT.h @@ -51,7 +51,7 @@ template< class KeyType > class __HashMapDefaultProviderT; * The %HashMapT class provides a template-based collection of associated keys and values * that are organized based on the hash code of the key. * It contains unique keys and each key maps to one single value. - * The key and value cannot be a null reference. Several methods in the %HashMapT class need assignment (=) operators of KeyType and ValueType. + * The key and value cannot be a @c null reference. Several methods in the %HashMapT class need the assignment (=) operators of the KeyType and the ValueType. * @n * For more information on the class features, see HashMap and MultiHashMap. * @@ -152,8 +152,9 @@ public: * @param[in] capacity The initial capacity * @param[in] loadFactor The maximum ratio of elements to buckets * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c capacity or the @c loadFactor is negative. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity or the specified @c loadFactor is negative. * @remarks To work properly, the key type must be of a primitive number type. * @see HashMapT() */ @@ -217,13 +218,15 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] map The map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets + * @param[in] map The map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c loadFactor is negative. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map is modified during the operation of this method. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c loadFactor is negative. + * @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 map is modified during the operation of this method. * @see HashMapT() */ result Construct(const IMapT< KeyType, ValueType >& map, float loadFactor = 0.75) @@ -264,24 +267,24 @@ CATCH: } /** - * Initializes this instance of an empty %HashMapT class, with the specified initial capacity, load factor, hash code provider, and comparer. + * Initializes this instance of the empty %HashMapT, with the specified initial capacity, load factor, hash code provider, and comparer. * * @since 2.0 * * @return An error code - * @param[in] capacity The initial capacity @n - * If it is @c 0, the default capacity (16) is used. - * @param[in] loadFactor The maximum ratio of the elements to buckets @n - * If it is @c 0, the default load factor (0.75) is used. - * @param[in] provider An instance of the IHashCodeProviderT-derived class that supplies the hash codes - * for all keys in this map - * @param[in] comparer An instance of the IComparerT-derived class to use when comparing keys + * @param[in] capacity The initial capacity @n + * If it is @c 0, the default capacity (16) is used. + * @param[in] loadFactor The maximum ratio of the elements to buckets @n + * If it is @c 0, the default load factor (0.75) is used. + * @param[in] provider An instance of the IHashCodeProviderT-derived class that supplies the hash codes + * for all the keys in this map + * @param[in] comparer An instance of the IComparerT-derived class to use when comparing the keys * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - A specified input parameter is invalid. @n - * - The specified @c capacity is negative. @n - * - The @c loadFactor is negative. - * @remarks The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity is negative. + * - The specified @c loadFactor is negative. + * @remarks The instances of the hash code provider and the comparer are not deallocated later from this map. * @see HashMapT() */ result Construct(int capacity, float loadFactor, const IHashCodeProviderT< KeyType >& provider, @@ -342,20 +345,21 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] map The map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor (0.75) is used. - * @param[in] provider An instance of the IHashCodeProviderT-derived class that supplies the hash codes - * for all keys in this map - * @param[in] comparer An instance of the IComparerT-derived class to use when comparing keys + * @param[in] map The map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor (0.75) is used. + * @param[in] provider An instance of the IHashCodeProviderT-derived class that supplies the hash codes + * for all the keys in this map + * @param[in] comparer An instance of the IComparerT-derived class to use when comparing the keys * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - A specified input parameter is invalid. @n - * - The @c loadFactor is negative. @n - * - The @c provider is a @c null or the @c comparer is a @c null. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map is modified during the operation of this method. - * @remarks The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c loadFactor is negative. + * - Either the specified @c provider or the specified @c comparer is @c null. + * @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 map is modified during the operation of this method. + * @remarks The instances of the hash code provider and the comparer are not deallocated later from this map. * @see HashMapT() */ result Construct(const IMapT< KeyType, ValueType >& map, float loadFactor, const IHashCodeProviderT< KeyType >& provider, @@ -391,16 +395,17 @@ CATCH: } /** - * Adds the specified key-value pair to a map. + * Adds the specified key-value pair to the map. * * @since 2.0 * * @return An error code - * @param[in] key The key of the value to add - * @param[in] value The value to add + * @param[in] key The key of the value to add + * @param[in] value The value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_ALREADY_EXIST The specified @c key already exists. * @see Remove() */ @@ -433,11 +438,11 @@ CATCH: } /** - * Gets the elements of a map in an instance of the IMapEnumeratorT-derived class. + * Gets the elements of the map through an instance of the IMapEnumeratorT-derived class. * * @since 2.0 * - * @return An instance of the IMapEnumeratorT-derived class if successful, @n + * @return An instance of the IMapEnumeratorT-derived class, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -461,11 +466,11 @@ CATCH: } /** - * Gets the elements of a map in an instance of the IMapEnumeratorT class. + * Gets the elements of the map through an instance of the IMapEnumeratorT class. * * @since 2.0 * - * @return An instance of the IMapEnumeratorT class if successful, @n + * @return An instance of the IMapEnumeratorT class, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -485,12 +490,13 @@ CATCH: * * @return The value associated with the key, @n * else @c null if an exception occurs - * @param[in] key The key to locate - * @param[out] value The value associated with the key + * @param[in] key The key to locate + * @param[out] value The value associated with the @c key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * The comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see SetValue() */ virtual result GetValue(const KeyType& key, ValueType& value) const @@ -526,12 +532,13 @@ CATCH: * * @return The value associated with the key, @n * else @c null if an exception occurs - * @param[in] key The key to locate - * @param[out] value The value associated with the key + * @param[in] key The key to locate + * @param[out] value The value associated with the @c key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see SetValue() */ virtual result GetValue(const KeyType& key, ValueType& value) @@ -540,16 +547,17 @@ CATCH: } /** - * Gets a list of all the keys in a map. + * Gets the list of all the keys in the map. * * @since 2.0 * - * @return A pointer to an IListT object containing all the keys in the map, @n + * @return A pointer to the IListT object that contains all the keys in the map, @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 order of the keys is the same as the corresponding values in the IListT interface returned by the GetValuesN() method. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The order of the keys is the same as the corresponding values in the IListT interface returned by the GetValuesN() method. + * - The specific error code can be accessed using the GetLastResult() method. * @see GetValuesN() */ virtual IListT< KeyType >* GetKeysN(void) const @@ -582,11 +590,11 @@ CATCH: } /** - * Gets all the values in a map. + * Gets all the values in the map. * * @since 2.0 * - * @return A pointer to an IListT object containing all the values in the map, @n + * @return A pointer to the IListT object that contains all the values in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -623,16 +631,17 @@ CATCH: } /** - * Removes the value associated with the specified @c key. + * Removes the value associated to the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key to remove + * @param[in] key The key to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add() */ virtual result Remove(const KeyType& key) @@ -675,7 +684,7 @@ CATCH: } /** - * Removes all key-value pairs in the map. + * Removes all the key-value pairs in the map. * * @since 2.0 */ @@ -695,14 +704,14 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] key The key for which the value is to replace - * @param[in] value The new value to replace + * @param[in] key The key whose value is replaced + * @param[in] value The new value to replace * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks Use the Add() method to add a new key-value pair. - * @see Add() * @see GetValue() */ virtual result SetValue(const KeyType& key, const ValueType& value) @@ -737,7 +746,7 @@ CATCH: } /** - * Gets the number of pairs currently stored in a map. + * Gets the number of pairs currently stored in the map. * * @since 2.0 * @@ -749,17 +758,18 @@ CATCH: } /** - * Checks whether a map contains the specified @c key. + * Checks whether the map contains the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[out] out Set to @c true if the map contains the specified @c key, @n - * else @c false + * @param[in] key The key to locate + * @param[out] out Set to @c true if the map contains the specified @c key, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsValue() */ virtual result ContainsKey(const KeyType& key, bool& out) const @@ -790,7 +800,7 @@ CATCH: } /** - * Checks whether a map contains the specified @c value. + * Checks whether the map contains the specified @c value. * * @since 2.0 * @@ -817,14 +827,14 @@ CATCH: } /** - * Compares two instances of the %HashMapT class. + * Compares two instances of %HashMapT. * * @since 2.0 * * @return @c true if the two instances match, @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 two instances contain the same number of elements and all the elements of each other. + * @remarks This method returns @c true if and only if the two instances contain the same number of elements and all the elements are present in both of them. */ virtual bool Equals(const Object& obj) const { @@ -870,8 +880,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 { @@ -1065,7 +1075,7 @@ public: * @param[in] k The key to include in this entry * @param[in] v The value to include in this entry * @param[in] next A pointer to the next entry - * @param[in] h A hash value of the key + * @param[in] h The hash value of the key */ __HashMapEntryT(const KeyType& k, const ValueType& v, __HashMapEntryT< KeyType, ValueType >* next, int h) : key(k) @@ -1160,9 +1170,10 @@ public: * @return An error code * @param[out] obj The current object * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION 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 or the map 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. + * - This enumerator is currently positioned before the first element or past the last element. + * - The map is modified after this enumerator is created. */ virtual result GetCurrent(MapEntryT< KeyType, ValueType >& obj) const { @@ -1175,17 +1186,17 @@ public: } /** - * Moves this enumerator to the next elements of the map. + * Moves this enumerator to the next element of the map. * When this enumerator is first created, or when the Reset() method is called, or when the %MoveNext() method is first called, the enumerator positions itself to the first element in the map. * * @since 2.0 * * @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 map 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 map is modified after this enumerator is created. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the map. - * @see Reset() */ virtual result MoveNext(void) { @@ -1213,14 +1224,15 @@ public: } /** - * Positions the enumerator before the first element in a map. + * Positions the enumerator before the first element in the map. * * @since 2.0 * * @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 map 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 map is modified after this enumerator is created. */ virtual result Reset(void) { @@ -1233,16 +1245,17 @@ public: } /** - * Gets the current key in a map. + * Gets the current key in the map. * * @since 2.0 * * @return An error code * @param[out] key The current key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION 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 or the map 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. + * - This enumerator is currently positioned before the first element or past the last element. + * - The map is modified after this enumerator is created. */ virtual result GetKey(KeyType& key) const { @@ -1255,16 +1268,17 @@ public: } /** - * Gets the current value in a map. + * Gets the current value in the map. * * @since 2.0 * * @return An error code - * @param[out] value The current value + * @param[out] value The current value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION 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 or the map is modified after the 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. + * - This enumerator is currently positioned before the first element or past the last element + * - The map is modified after the enumerator is created. */ virtual result GetValue(ValueType& value) const { diff --git a/inc/FBaseColIBidirectionalEnumerator.h b/inc/FBaseColIBidirectionalEnumerator.h index 371ad85..05449db 100644 --- a/inc/FBaseColIBidirectionalEnumerator.h +++ b/inc/FBaseColIBidirectionalEnumerator.h @@ -36,13 +36,13 @@ namespace Tizen { namespace Base { namespace Collection * * @since 2.0 * - * @remarks - * An enumerator remains valid as long as the collection remains unchanged. - * If changes are made to the collection, such as adding, modifying, or - * deleting elements, the enumerator is irrecoverably invalidated. The next call to GetCurrent(), MoveNext(), MovePrevious(), Reset(), or ResetLast() fails (E_INVALID_OPERATION). + * @remarks An enumerator remains valid as long as the collection remains unchanged.@n + * If changes are made to the collection, such as adding, modifying, or + * deleting elements, the enumerator is irrecoverably invalidated. @n + * The next call to GetCurrent(), MoveNext(), MovePrevious(), Reset(), or ResetLast() fails (@c E_INVALID_OPERATION). * * The %IBidirectionalEnumerator interface supports a bidirectional iteration over a collection. - * One can only access the elements in a collection through %IBidirectionalEnumerator. The elements cannot be modified through this interface. + * One can only access the elements in a collection through %IBidirectionalEnumerator. The elements cannot be modified through this interface. */ class _OSP_EXPORT_ IBidirectionalEnumerator : public virtual IEnumerator @@ -58,17 +58,17 @@ public: /** * Moves %IBidirectionalEnumerator to the previous element of the collection. @n - * A call to the MovePrevious() method after the ResetLast() method positions the enumerator to the last element in the collection. + * A call to the %MovePrevious() method after the ResetLast() method, positions the enumerator to the last element in the collection. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The enumerator has passed the front of the collection. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the 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 collection is modified after the enumerator is created. * @see Tizen::Base::Collection::IEnumerator::MoveNext() - * @see ResetLast() */ virtual result MovePrevious(void) = 0; @@ -79,8 +79,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 collection is modified after the 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 collection is modified after the enumerator is created. * @see Tizen::Base::Collection::IEnumerator::Reset() * @see MovePrevious() */ diff --git a/inc/FBaseColIBidirectionalEnumeratorT.h b/inc/FBaseColIBidirectionalEnumeratorT.h index d12fe54..ae0c916 100644 --- a/inc/FBaseColIBidirectionalEnumeratorT.h +++ b/inc/FBaseColIBidirectionalEnumeratorT.h @@ -36,10 +36,10 @@ namespace Tizen { namespace Base { namespace Collection * * @since 2.0 * - * @remarks - * An enumerator remains valid as long as the collection remains unchanged. - * If changes are made to the collection, such as adding, modifying, or - * deleting elements, the enumerator is irrecoverably invalidated. The next call to GetCurrent(), MoveNext(), MovePrevious(), Reset(), or ResetLast() fails (E_INVALID_OPERATION). + * @remarks An enumerator remains valid as long as the collection remains unchanged.@n + * If changes are made to the collection, such as adding, modifying, or + * deleting elements, the enumerator is irrecoverably invalidated. @n + * The next call to GetCurrent(), MoveNext(), MovePrevious(), Reset(), or ResetLast() fails (@c E_INVALID_OPERATION). * * The %IBidirectionalEnumeratorT interface supports a bidirectional iteration over a collection. * One can only access the elements in a collection through %IBidirectionalEnumeratorT. The elements cannot be modified through this interface. @@ -67,10 +67,10 @@ public: * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The enumerator has passed the front of the collection. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the 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, or + * - The collection is modified after the enumerator is created. * @see Tizen::Base::Collection::IEnumeratorT< Type >::MoveNext() - * @see ResetLast() */ virtual result MovePrevious(void) = 0; @@ -81,8 +81,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 collection is modified after the 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 collection is modified after the enumerator is created. * @see Tizen::Base::Collection::IEnumeratorT< Type >::Reset() * @see MovePrevious() */ diff --git a/inc/FBaseColICollection.h b/inc/FBaseColICollection.h index e3cac90..058754f 100644 --- a/inc/FBaseColICollection.h +++ b/inc/FBaseColICollection.h @@ -42,11 +42,11 @@ namespace Tizen { namespace Base { namespace Collection /** * @interface ICollection * @brief This interface represents a collection of objects. @n - * It defines the size, enumerators, and the synchronization mechanism of a collection. + * It defines the size, the enumerators, and the synchronization mechanism of a collection. * * @since 2.0 * - * The %ICollection interface represents a collection of objects. It defines the size, enumerators, and the synchronization mechanism of a collection. + * The %ICollection interface represents a collection of objects. It defines the size, the enumerators, and the synchronization mechanism of a collection. * */ class _OSP_EXPORT_ ICollection @@ -65,24 +65,24 @@ public: * * @since 2.0 * - * @return An integer value indicating the number of objects currently stored in the collection + * @return The integer value that indicates the number of objects currently stored in the collection */ virtual int GetCount(void) const = 0; /** * Gets the enumerator of the %ICollection derived class, - * or returns @c null if some exception occurs. + * or returns @c null if an exception occurs. * * @since 2.0 * - * @return A pointer to an enumerator interface of the %ICollection derived class, @n + * @return A pointer to the enumerator interface of the %ICollection derived class, @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 Use this method to obtain an enumerator (an instance of the IEnumerator derived class) + * @remarks + * - Use this method to obtain an enumerator (an instance of the IEnumerator derived class) * to iterate over a collection (an instance of the %ICollection derived class). - * @remarks The specific error code can be accessed using GetLastResult() method. - * @see Tizen::Base::Collection::IEnumerator + * - The specific error code can be accessed using GetLastResult() method. * */ virtual IEnumerator* GetEnumeratorN(void) const = 0; diff --git a/inc/FBaseColICollectionT.h b/inc/FBaseColICollectionT.h index 859d4bd..d0b5d21 100644 --- a/inc/FBaseColICollectionT.h +++ b/inc/FBaseColICollectionT.h @@ -35,12 +35,12 @@ namespace Tizen { namespace Base { namespace Collection /** * @interface ICollectionT * @brief This interface represents a template-based collection of objects. - * It defines the size, and enumerators. + * It defines the size, and the enumerators. * * @since 2.0 * * The %ICollectionT interface represents a template-based collection of objects. - * It defines the size, and enumerators. + * It defines the size, and the enumerators. */ template< class Type > class ICollectionT @@ -69,14 +69,14 @@ public: * * @since 2.0 * - * @return A pointer to an enumerator interface of the %ICollectionT derived class, @n + * @return A pointer to the enumerator interface of the %ICollectionT derived class, @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 Use this method to obtain an enumerator (an instance of the IEnumeratorT derived class) + * @remarks + * - Use this method to obtain the enumerator (an instance of the IEnumeratorT derived class) * to iterate over a collection (an instance of the %ICollectionT derived class). - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IEnumerator + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IEnumeratorT< Type >* GetEnumeratorN(void) const = 0; diff --git a/inc/FBaseColIComparer.h b/inc/FBaseColIComparer.h index 689b1f2..a210d4e 100644 --- a/inc/FBaseColIComparer.h +++ b/inc/FBaseColIComparer.h @@ -30,11 +30,11 @@ namespace Tizen { namespace Base { namespace Collection { /** * @interface IComparer - * @brief This interface allows a derived class to compare 2 objects of the same type. + * @brief This interface allows a derived class to compare two objects of the same type. * * @since 2.0 * - * The %IComparer interface allows a derived class to compare 2 objects of the same type. + * The %IComparer interface allows a derived class to compare two objects of the same type. */ class _OSP_EXPORT_ IComparer { @@ -56,15 +56,15 @@ public: * @return An error code * @param[in] obj1 The first object to compare * @param[in] obj2 The second object to compare - * @param[out] cmp The result of comparison + * @param[out] cmp The result of the comparison * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified object instances are not of the expected type. * @remarks The value of @c cmp can be: * * @code - * < 0 if the value of @c obj1 is less than the value of @c obj2 - * == 0 if the value of @c obj1 is equal to the value of @c obj2 - * > 0 if the value of @c obj1 is greater than the value of @c obj2 + * < 0 if the value of obj1 is less than the value of obj2 + * == 0 if the value of obj1 is equal to the value of obj2 + * > 0 if the value of obj1 is greater than the value of obj2 * @endcode */ virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const = 0; diff --git a/inc/FBaseColIComparerT.h b/inc/FBaseColIComparerT.h index f1c6f42..a2667ee 100644 --- a/inc/FBaseColIComparerT.h +++ b/inc/FBaseColIComparerT.h @@ -29,11 +29,11 @@ namespace Tizen { namespace Base { namespace Collection { /** * @interface IComparerT - * @brief This interface allows derived classes to compare 2 template-based objects of the same type. + * @brief This interface allows derived classes to compare two template-based objects of the same type. * * @since 2.0 * - * The %IComparerT interface allows derived classes to compare 2 template-based objects of the + * The %IComparerT interface allows derived classes to compare two template-based objects of the * same type. */ template< class Type > @@ -57,15 +57,15 @@ public: * @return An error code * @param[in] obj1 The first object to compare * @param[in] obj2 The second object to compare - * @param[out] cmp The result of comparison + * @param[out] cmp The result of the comparison * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified object instances are not of the expected type. * @remarks The value of @c cmp can be: * * @code - * < 0 if the value of @c obj1 is less than the value of @c obj2 - * == 0 if the value of @c obj1 is equal to the value of @c obj2 - * > 0 if the value of @c obj1 is greater than the value of @c obj2 + * < 0 if the value of obj1 is less than the value of obj2 + * == 0 if the value of obj1 is equal to the value of obj2 + * > 0 if the value of obj1 is greater than the value of obj2 * @endcode */ virtual result Compare(const Type& obj1, const Type& obj2, int& cmp) const = 0; diff --git a/inc/FBaseColIEnumerator.h b/inc/FBaseColIEnumerator.h index 24c363b..ef2eaa2 100644 --- a/inc/FBaseColIEnumerator.h +++ b/inc/FBaseColIEnumerator.h @@ -40,11 +40,11 @@ namespace Tizen { namespace Base { namespace Collection * * @since 2.0 * - * @remarks - * An enumerator remains valid as long as the collection remains unchanged. - * If changes are made to the collection, such as adding, modifying, or - * deleting elements, the enumerator is irrecoverably invalidated. The next call to GetCurrent(), MoveNext(), or Reset() fails and returns - * E_INVALID_OPERATION. + * @remarks An enumerator remains valid as long as the collection remains unchanged. @n + * If changes are made to the collection, such as adding, modifying, or + * deleting elements, the enumerator is irrecoverably invalidated. @n + * The next call to GetCurrent(), MoveNext(), or Reset() fails and returns + * @c E_INVALID_OPERATION. * * The %IEnumerator interface supports simple iteration over a collection. * One can only access the elements in a collection through %IEnumerator. The elements cannot be modified through this interface. @@ -69,13 +69,12 @@ public: * @return The current object in the collection, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. - * @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. * - The enumerator is currently positioned before the first element - * or after the last element. @n + * or after the last element. * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see GetLastResult() */ virtual Tizen::Base::Object* GetCurrent(void) const = 0; @@ -89,9 +88,9 @@ public: * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the collection. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. - * @see Reset() + * @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 collection is modified after the enumerator is created. */ virtual result MoveNext(void) = 0; @@ -102,8 +101,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 collection is modified after the 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 collection is modified after the enumerator is created. */ virtual result Reset(void) = 0; diff --git a/inc/FBaseColIEnumeratorT.h b/inc/FBaseColIEnumeratorT.h index d26de5f..45c07fb 100644 --- a/inc/FBaseColIEnumeratorT.h +++ b/inc/FBaseColIEnumeratorT.h @@ -36,11 +36,11 @@ namespace Tizen { namespace Base { namespace Collection * * @since 2.0 * - * @remarks - * An enumerator remains valid as long as the collection remains unchanged. - * If changes are made to the collection, such as adding, modifying, or - * deleting elements, the enumerator is irrecoverably invalidated. The next call to GetCurrent(), MoveNext(), or Reset() fails and returns - * E_INVALID_OPERATION. + * @remarks An enumerator remains valid as long as the collection remains unchanged. @n + * If changes are made to the collection, such as adding, modifying, or + * deleting elements, the enumerator is irrecoverably invalidated. @n + * The next call to GetCurrent(), MoveNext(), or Reset() fails and returns + * @c E_INVALID_OPERATION. * * The %IEnumeratorT interface supports simple iteration over a template-based collection. * One can only access the elements in a collection through %IEnumeratorT. The elements cannot be modified through this interface. @@ -64,11 +64,13 @@ public: * @since 2.0 * * @return An error code - * @param[out] obj A pointer to the current object + * @param[out] obj A pointer to the current object * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n - * The enumerator is currently positioned before the first element or - * after the last element or the collection is modified after the 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 enumerator is currently positioned before the first element or + * after the last element. + * - The collection is modified after the enumerator is created. */ virtual result GetCurrent(Type& obj) const = 0; @@ -82,9 +84,9 @@ public: * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the collection. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. - * @see Reset() + * @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 collection is modified after the enumerator is created. */ virtual result MoveNext(void) = 0; @@ -95,8 +97,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 collection is modified after the 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 collection is modified after the enumerator is created. */ virtual result Reset(void) = 0; diff --git a/inc/FBaseColIHashCodeProvider.h b/inc/FBaseColIHashCodeProvider.h index 9ccd9d1..3e527ac 100644 --- a/inc/FBaseColIHashCodeProvider.h +++ b/inc/FBaseColIHashCodeProvider.h @@ -33,11 +33,11 @@ namespace Tizen { namespace Base { namespace Collection /** * @interface IHashCodeProvider - * @brief This interface represents classes that can provide the hash code of a specific type of object. + * @brief This interface represents classes that provide the hash code of a specific type of object. * * @since 2.0 * - * The %IHashCodeProvider interface represents classes that can provide the hash code of a specific type of object. + * The %IHashCodeProvider interface represents classes that provide the hash code of a specific type of object. */ class _OSP_EXPORT_ IHashCodeProvider { @@ -56,10 +56,11 @@ public: * @since 2.0 * * @return The hash code of the specified object - * @param[in] obj A pointer to the object whose hash code is required - * @remarks The hash algorithm is usually specific to a type. - * Two equal instances must return the same hash value. - * For better performance, the used hash function must generate a random distribution for all inputs. + * @param[in] obj A pointer to the object whose hash code is required + * @remarks + * - The hash algorithm is usually of a specific type. + * - Two equal 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(const Tizen::Base::Object& obj) const = 0; diff --git a/inc/FBaseColIHashCodeProviderT.h b/inc/FBaseColIHashCodeProviderT.h index e691354..c3694dc 100644 --- a/inc/FBaseColIHashCodeProviderT.h +++ b/inc/FBaseColIHashCodeProviderT.h @@ -28,11 +28,11 @@ namespace Tizen { namespace Base { namespace Collection /** * @interface IHashCodeProviderT - * @brief This interface represents classes that can provide the hash code of a specific type of template-based object. + * @brief This interface represents classes that provide the hash code of a specific type of template-based object. * * @since 2.0 * - * The %IHashCodeProviderT interface represents classes that can provide the hash code of a specific type of template-based object. + * The %IHashCodeProviderT interface represents classes that provide the hash code of a specific type of template-based object. * */ template< class Type > @@ -53,10 +53,11 @@ public: * @since 2.0 * * @return The hash code of the specified object - * @param[in] obj A pointer to the object for which the hash code is required - * @remarks The hash algorithm is usually specific to a type. @n - * Two equal instances must return the same hash value. - * For better performance, the used hash function must generate a random distribution for all inputs. + * @param[in] obj A pointer to the object whose hash code is required + * @remarks + * - The hash algorithm is usually of a specific type. + * - Two equal 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(const Type& obj) const = 0; diff --git a/inc/FBaseColIList.h b/inc/FBaseColIList.h index 21811c1..7f9120f 100644 --- a/inc/FBaseColIList.h +++ b/inc/FBaseColIList.h @@ -58,7 +58,7 @@ public: * Adds the specified object to the list. * * @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 Add(Object* pObj). * @since 2.0 * @@ -66,12 +66,14 @@ public: * @param[in] obj The object to add * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks In a collection of contiguous elements, such as a list, the elements - * that follow the insertion point move down to accommodate the new element. + * @remarks + * - In a collection of contiguous elements, such as a list, the elements + * that follow the insertion point move down to accommodate the new element. @n * If the collection is indexed, the indexes of the elements that are moved - * are also updated. This behavior does not apply to collections where + * are also updated. @n + * This behavior does not apply to collections where * elements are conceptually grouped into buckets, such as a hashtable. - * This method performs a shallow copy. It adds the pointer only; not the element itself. + * - This method performs a shallow copy. It adds just the pointer only and not the element itself. * @see Remove() * @endif */ @@ -86,45 +88,48 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to add + * @param[in] pObj A pointer to the object to add * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @remarks In a collection of contiguous elements, such as a list, the elements - * that follow the insertion point move down to accommodate the new element. + * @remarks + * - In a collection of contiguous elements, such as a list, the elements + * that follow the insertion point move down to accommodate the new element. @n * If the collection is indexed, the indexes of the elements that are moved - * are also updated. This behavior does not apply to collections where + * are also updated. @n + * This behavior does not apply to collections where * elements are conceptually grouped into buckets, such as a hashtable. - * This method performs a shallow copy. It adds the pointer only; not the element itself. + * - This method performs a shallow copy. It adds just the pointer only and not the element itself. * @see Remove() */ virtual result Add(Object* pObj) = 0; /** - * Adds the elements of the specified collection to the end of the list. + * Adds the elements of the specified @c collection to the end of the list. * * @since 2.0 * * @return An error code * @param[in] collection The collection to add to the list * @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. - * @remarks This method performs a shallow copy. It adds the pointer only; 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 adds just the pointer only and not the element itself. * @see RemoveItems() */ virtual result AddItems(const ICollection& collection) = 0; /** * Searches for an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. */ virtual result IndexOf(const Object& obj, int& index) const = 0; @@ -133,19 +138,22 @@ public: * Inserts an object at the specified location in the list. * * @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 InsertAt(const Object* pObj, int index). * @since 2.0 * * @return An error code - * @param[in] obj The object to insert - * @param[in] index The index at which the object must be inserted + * @param[in] obj The object to insert + * @param[in] index The index at which the object is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is greater than the number of elements in the list or less than @c 0. - * @remarks If the @c index equals the number of elements in the list, the new element + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements in the list. + * - The specified @c index is less than @c 0. + * @remarks + * - If the @c index equals the number of elements in the list, the new element * is added at the end of the list. - * This method performs a shallow copy. It inserts the pointer only; not the element itself. + * - This method performs a shallow copy. It inserts just the pointer only and not the element itself. * @see Add(Object*) * @see RemoveAt() * @endif @@ -161,72 +169,78 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to insert - * @param[in] index The index at which the object must be inserted + * @param[in] pObj A pointer to the object to insert + * @param[in] index The index at which the object is inserted * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is greater than the number of elements in the list or less than @c 0. - * @remarks If the @c index equals the number of elements in the list, the new element + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements in the list. + * - The specified @c index is less than @c 0. + * @remarks + * - If the @c index equals the number of elements in the list, the new element * is added at the end of the list. - * This method performs a shallow copy. It inserts the pointer only; not the element itself. + * - This method performs a shallow copy. It inserts just the pointer only and not the element itself. * @see Add(Object*) * @see RemoveAt() */ virtual result InsertAt(Object* pObj, int index) = 0; /** - * Searches for an object starting from the specified index. @n - * Gets the index of the object if found. + * Searches for an object starting from the specified @c index. @n + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index for the search @n - * It must be less than the number of elements. - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index for the search @n + * It must be less than the number of elements. + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int startIndex, int& index) const = 0; /** * Searches for an object within the specified range. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int startIndex, int count, int& index) const = 0; /** - * Searches for the last occurrence of an object in this list. @n - * Gets the index of the object if found. + * Searches for the last occurrence of an object in the list. @n + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the last occurrence of the specified object + * @param[in] obj The object to locate + * @param[out] index The index of the last occurrence of the specified object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see IndexOf() */ virtual result LastIndexOf(const Object& obj, int& index) const = 0; @@ -237,16 +251,20 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to insert - * @param[in] startIndex The starting index at which the collection must be inserted + * @param[in] collection The collection to insert + * @param[in] startIndex The starting index at which the collection is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c startIndex is greater than the number of elements in the list or less than @c 0. - * @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. - * @remarks If the @c startIndex equals the number of elements in the list, the new elements + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is greater than the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * @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 + * - If the @c startIndex is equal to the number of elements in the list, the new elements * are added at the end of the list. - * This method performs a shallow copy. It inserts just the pointer; not the element itself. + * - This method performs a shallow copy. It inserts just the pointer and not the element itself. * @see RemoveItems() * @see AddItems() */ @@ -258,11 +276,13 @@ public: * @since 2.0 * * @return The object at the specified location, @n - * else @c null if the @c index is not valid - * @param[in] index The index of the object to get + * else @c null if the @c index invalid + * @param[in] index The index of the object to get * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetAt() */ @@ -274,11 +294,13 @@ public: * @since 2.0 * * @return The object at the specified location, @n - * else @c null if the @c index is not valid + * else @c null if the @c index invalid * @param[in] index The index of the object to get * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetAt() */ @@ -289,18 +311,20 @@ public: * * @since 2.0 * - * @return A pointer to an %IList with elements lying within the specified range, @n + * @return A pointer to the %IList that contains elements lying within the specified range, @n * else @c null if an exception occurs - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The @c count is greater than the number of elements in the list starting from @c startIndex - * or less than @c 0. - * @remarks The %IList stores just the pointers to the elements in the list, not the elements themselves. - * The specific error code can be accessed using the GetLastResult() method. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements in the list starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @remarks + * - The %IList stores just the pointers to the elements in the list and not the elements themselves. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IList* GetItemsN(int startIndex, int count) const = 0; @@ -310,15 +334,15 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj The object to remove + * @param[in] obj The object to remove * @param[in] forceDeletion Set to @c true to deallocate the object, @n * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting. * - Remove(obj, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -362,7 +386,7 @@ public: * @return An error code * @param[in] obj The object to remove * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see Add(Object*) * @see RemoveAt() */ @@ -374,16 +398,18 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index at which the object must be removed - * @param[in] forceDeletion Set to @c true to deallocate the object, @n - * else @c false + * @param[in] index The index at which the object is removed + * @param[in] forceDeletion Set to @c true to deallocate the object, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting. * - RemoveAt(index, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -423,10 +449,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index at which the object must be removed + * @param[in] index The index at which the object is removed * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. */ virtual result RemoveAt(int index) = 0; @@ -436,20 +464,21 @@ public: * @since 2.0 * * @return An error code - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements in the range - * @param[in] forceDeletion Set to @c true to deallocate the object, @n - * else @c false + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements in the range + * @param[in] forceDeletion Set to @c true to deallocate the object, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting. * - RemoveItems(startIndex, count, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -490,14 +519,15 @@ public: * @since 2.0 * * @return An error code - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements in the range + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements in the range * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * @see AddItems() */ virtual result RemoveItems(int startIndex, int count) = 0; @@ -508,16 +538,17 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to be removed from this list + * @param[in] collection The collection to remove from this list * @param[in] forceDeletion Set to @c true to deallocate the object, @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. * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting. * - RemoveItems(collection, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -554,15 +585,16 @@ public: } /** - * Removes all the elements from the list that are common to the specified collection. + * Removes all the elements from the list that are common to the specified @c collection. * * @since 2.0 * * @return An error code * @param[in] collection The collection to remove from this list * @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 Remove() * @see RemoveAt() */ @@ -570,7 +602,7 @@ public: /** * Removes all the object pointers in the collection. @n - * If the deallocate param is set to @c true, it removes all the objects in the collection. @n + * If @c forceDeletion is set to @c true, it removes all the objects from the collection. @n * This method can be called just before deleting the collection. * * @since 2.0 @@ -579,9 +611,9 @@ public: * @param[in] forceDeletion Set to @c true to deallocate all the objects, @n * else @c false * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting. * - RemoveAll(@b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -615,7 +647,7 @@ public: } /** - * Removes all the object pointers in the collection. @n + * Removes all the object pointers from the collection. @n * This method can be called just before deleting the collection. * * @since 2.0 @@ -623,22 +655,24 @@ public: virtual void RemoveAll(void) = 0; /** - * Replaces the object at the specified index with the specified object. + * Replaces the object at the specified @c index with the specified object. * * @since 2.0 * * @return An error code - * @param[in] obj The new object - * @param[in] index The index at which the new object must be set - * @param[in] forceDeletion Set to @c true to deallocate the object, @n - * else @c false + * @param[in] obj The new object + * @param[in] index The index at which the new object is set + * @param[in] forceDeletion Set to @c true to deallocate the object, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks - * - Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n - * If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the set operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the set method. @n + * If both the element deleter and the @c forceDeleteion are set, the set operation follows the @c forceDeletion setting. * - SetAt(obj, index, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -674,28 +708,30 @@ public: } /** - * Replaces the object at the specified index with the specified object. + * Replaces the object at the specified @c index with the specified object. * * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to new object - * @param[in] index The index at which the new object must be set + * @param[in] pObj A pointer to the new object + * @param[in] index The index at which the new object is set * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @see GetAt() */ virtual result SetAt(Object* pObj, int index) = 0; /** - * Sorts the elements of this list using the comparer provided. + * Sorts the elements of the list using the @c comparer provided. * * @since 2.0 * * @return An error code - * @param[in] comparer The IComparer implementation to use when comparing elements + * @param[in] comparer The IComparer implementation to use when comparing the elements * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ @@ -714,22 +750,23 @@ public: /** * @if OSPDEPREC - * Checks whether the list contains all the elements of the specified collection. + * Checks whether the list contains all the elements of the specified @c 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 check for containment in this list - * @param[out] out Set to @c true if the list contains all the elements of the specified collection, @n - * else @c false + * @param[in] collection The collection to check for containment in this list + * @param[out] out Set to @c true if the list contains all the elements of 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. - * @remarks If the given @c collection is empty, the @c out parameter is set to @c true. + * @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 If the given @c collection is empty, then @c out is set to @c true. * @see Contains() * @endif */ @@ -741,44 +778,45 @@ public: } /** - * Checks whether the list contains all the elements of the specified collection. + * Checks whether the list contains all the elements of the specified @c collection. * * @since 2.0 * * @return @c true if the list contains all the elements of the specified collection, @n - * else @c false + * else @c false * @param[in] collection The collection to check for containment in this list * @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. * @remarks * - The specific error code can be accessed using the GetLastResult() method. - * - If the given @c collection is empty, this method will return @c true. + * - If the given @c collection is empty, this method returns @c true. * @see Contains() */ virtual bool ContainsAll(const ICollection& collection) const = 0; /** - * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list. + * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list. * * @since 2.0 * - * @return A pointer to a bidirectional enumerator interface of the %IList derived class, @n + * @return A pointer to the bidirectional enumerator interface of the %IList derived class, @n * else @c null if an exception occurs - * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) + * @remarks + * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) * to iterate over a collection (an instance of the %IList derived class). - * The specific error code can be accessed using GetLastResult() method. - * @see Tizen::Base::Collection::IBidirectionalEnumerator + * - The specific error code can be accessed using GetLastResult() method. */ virtual IBidirectionalEnumerator* GetBidirectionalEnumeratorN(void) const = 0; /** - * This method is for distinguishing between ArrayList and LinkedList. + * Checks whether the instance is an ArrayList or a LinkedList. * * @since 2.0 * * @return @c true if it is an ArrayList, @n - * else @c false if it is a LinkedList. + * else @c false if it is a LinkedList */ virtual bool IsRandomAccessible(void) const { diff --git a/inc/FBaseColIListT.h b/inc/FBaseColIListT.h index b0109fd..6729b7d 100644 --- a/inc/FBaseColIListT.h +++ b/inc/FBaseColIListT.h @@ -78,78 +78,82 @@ public: * @return An error code * @param[in] collection The collection to add * @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 RemoveItems() */ virtual result AddItems(const ICollectionT< Type >& collection) = 0; /** * Searches for an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. */ virtual result IndexOf(const Type& obj, int& index) const = 0; /** - * Searches for an object starting from the specified index. @n - * Gets the index of the object if found. + * Searches for an object starting from the specified @c startIndex. @n + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index for the search @n - * It must be less than the number of elements. - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index for the search @n + * It must be less than the number of elements. + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int startIndex, int& index) const = 0; /** * Searches for an object within the specified range. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int startIndex, int count, int& index) const = 0; /** * Searches for the last occurrence of an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the last occurrence of the specified object + * @param[in] obj The object to locate + * @param[out] index The index of the last occurrence of the specified object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see IndexOf() */ virtual result LastIndexOf(const Type& obj, int& index) const = 0; @@ -160,12 +164,14 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj The object to insert - * @param[in] index The index at which the object must be inserted + * @param[in] obj The object to insert + * @param[in] index The index at which the object is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is greater than the number of elements in the list or less than @c 0. - * @remarks If the @c index equals the number of elements in the list, the new element + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements in the list. + * - The specified @c index is less than @c 0. + * @remarks If the @c index is equal to the number of elements in the list, the new element * is added at the end of the list. * @see Add() * @see RemoveAt() @@ -173,18 +179,21 @@ public: virtual result InsertAt(const Type& obj, int index) = 0; /** - * Inserts the elements of a collection in the list at the specified location. + * Inserts the elements of a collection at the specified location in the list. * * @since 2.0 * * @return An error code - * @param[in] collection The collection to insert - * @param[in] startIndex The starting index at which the collection must be inserted + * @param[in] collection The collection to insert + * @param[in] startIndex The starting index at which the collection is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c startIndex is greater than the number of elements in the list or less than @c 0. - * @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_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is greater than the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * @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 If the @c startIndex equals the number of elements in the list, the new elements * are added at the end of the list. * @see RemoveItems() @@ -198,11 +207,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index of the object to get - * @param[out] obj The object obtained from the list + * @param[in] index The index of the object to get + * @param[out] obj The object obtained from the list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @see SetAt() */ virtual result GetAt(int index, Type& obj) const = 0; @@ -213,11 +224,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index of the object to get - * @param[out] obj The object obtained from the list + * @param[in] index The index of the object to get + * @param[out] obj The object obtained from the list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @see SetAt() */ virtual result GetAt(int index, Type& obj) = 0; @@ -227,16 +240,17 @@ public: * * @since 2.0 * - * @return A pointer to %IListT with elements lying within the specified range, @n + * @return A pointer to %IListT that contains the elements lying within the specified range, @n * else @c null if an exception occurs - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The @c count is greater than the number of elements in the list starting from @c startIndex - * or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements in the list starting from @c startIndex. + * - The specified @c count is less than @c 0. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual IListT< Type >* GetItemsN(int startIndex, int count) const = 0; @@ -249,7 +263,7 @@ public: * @return An error code * @param[in] obj The object to remove * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The object is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. */ virtual result Remove(const Type& obj) = 0; @@ -259,23 +273,26 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index at which the object must be removed + * @param[in] index The index at which the object is removed * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. */ virtual result RemoveAt(int index) = 0; /** - * Removes all the elements from the list that are common to the specified collection. + * Removes all the elements from the list that are common to the specified @c collection. * * @since 2.0 * * @return An error code * @param[in] collection The collection to remove from this list * @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 Remove() * @see RemoveAt() */ @@ -287,48 +304,51 @@ public: * @since 2.0 * * @return An error code - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements in the range + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements in the range * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * @see AddItems() * @see InsertItemsFrom() */ virtual result RemoveItems(int startIndex, int count) = 0; /** - * Removes all the elements in the list. + * Removes all the elements from the list. * * @since 2.0 */ virtual void RemoveAll(void) = 0; /** - * Sets the object at the specified index with the specified object. + * Sets the object at the specified @c index with the specified object. * * @since 2.0 * * @return An error code - * @param[in] obj The new object - * @param[in] index The index at which the new object must be set + * @param[in] obj The new object + * @param[in] index The index at which the new object is set * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @see GetAt() */ virtual result SetAt(const Type& obj, int index) = 0; /** - * Sorts the elements of this list using the comparer provided. + * Sorts the elements of this list using the @c comparer provided. * * @since 2.0 * * @return An error code - * @param[in] comparer The IComparerT implementation to use when comparing elements + * @param[in] comparer The IComparerT implementation to use when comparing the elements * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ @@ -346,35 +366,36 @@ public: virtual bool Contains(const Type& obj) const = 0; /** - * Checks whether the list contains all the elements of the specified collection. + * Checks whether the list contains all the elements of the specified @c collection. * * @since 2.0 * * @return An error code - * @param[in] collection The collection to check for containment in this list - * @param[out] out Set to @c true if the list contains all the elements of the specified collection, @n - * else @c false + * @param[in] collection The collection to check for containment in this list + * @param[out] out Set to @c true if the list contains all the elements of 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. - * @remarks If the given @c collection is empty, the @c out parameter is set to @c true. + * @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 If the given @c collection is empty, then @c out is set to @c true. * @see Contains() */ virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const = 0; /** - * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list. + * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list. * * @since 2.0 * - * @return A pointer to a bidirectional enumerator interface of the %IListT derived class, @n + * @return A pointer to the bidirectional enumerator interface of the %IListT derived class, @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 Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) - * to iterate over a collection (an instance of the %IListT derived class). - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IBidirectionalEnumeratorT + * @remarks + * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) + * to iterate over a collection (an instance of the %IListT derived class). + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IBidirectionalEnumeratorT< Type >* GetBidirectionalEnumeratorN(void) const = 0; diff --git a/inc/FBaseColIMap.h b/inc/FBaseColIMap.h index 01faca3..b7593f8 100644 --- a/inc/FBaseColIMap.h +++ b/inc/FBaseColIMap.h @@ -40,7 +40,7 @@ class MapEntry; * * @since 2.0 * - * The %IMap interface abstracts a collection of key-value pairs. An %IMap instance + * The %IMap interface represents a collection of key-value pairs. An %IMap instance * contains unique keys and each key maps to a single value. * The key and value cannot be a @c null reference. * @@ -63,18 +63,19 @@ public: * Adds the specified key-value pair to the map. * * @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 Add(Object* pKey, Object* pValue). * @since 2.0 * * @return An error code - * @param[in] key The key to add - * @param[in] value The corresponding value to add + * @param[in] key The key to add + * @param[in] value The corresponding value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_ALREADY_EXIST The specified @c key already exists. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Remove() * @endif */ @@ -89,29 +90,31 @@ public: * @since 2.0 * * @return An error code - * @param[in] pKey The pointer to key to add - * @param[in] pValue The pointer to corresponding value to add + * @param[in] pKey A pointer to the key to add + * @param[in] pValue A pointer to the corresponding value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_ALREADY_EXIST The specified @c pKey already exists. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Remove() */ virtual result Add(Object* pKey, Object* pValue) = 0; /** - * Checks if the key exists. If the key does not exist, Add() is called. Unless, SetValue() is called. + * Checks whether the key exists. If the key does not exist, the Add() method is called. Unless, the SetValue() method is called. * * @since 2.0 * * @return An error code - * @param[in] pKey The pointer to key to add - * @param[in] pValue The pointer to corresponding value to add + * @param[in] pKey A pointer to the key to add + * @param[in] pValue A pointer to the corresponding value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Add(Object*, Object*) * @see SetValue() */ @@ -128,34 +131,36 @@ public: } /** - * Gets the value associated with the specified key. + * Gets the value associated to the specified @c key. * * @since 2.0 * - * @return The value associated with the specified key, @n + * @return The value associated to the specified key, @n * else @c null if an exception occurs - * @param[in] key The key to find the associated value + * @param[in] key The key used to find the associated value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetValue() */ virtual const Object* GetValue(const Object& key) const = 0; /** - * Gets the value associated with the specified key. + * Gets the value associated to the specified @c key. * * @since 2.0 * - * @return The value associated with the specified key, @n + * @return The value associated to the specified key, @n * else @c null if an exception occurs - * @param[in] key The key to find the associated value + * @param[in] key The key used to find the associated value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetValue() */ @@ -166,47 +171,47 @@ public: * * @since 2.0 * - * @return A pointer to a list of all the keys in the map, @n + * @return A pointer to the list of all the keys in the map, @n * else @c null if an exception occurs * @remarks * - The order of the keys is the same as the corresponding values in the IList interface returned by the GetValuesN() method. - * - The %IList interface stores just the pointers to the elements in the map, not the elements themselves. + * - The %IList interface stores just the pointers to the elements in the map and not the elements themselves. * - The specific error code can be accessed using the GetLastResult() method. - * @see GetValuesN() */ virtual IList* GetKeysN(void) const = 0; /** - * Gets a list of all the values in the map. + * Gets the list of all the values in the map. * * @since 2.0 * - * @return A pointer to a list of all the values in the map, @n + * @return A pointer to the list of all the values in the map, @n * else @c null if an exception occurs * @remarks - * - The IList stores just the pointers to the elements in the map, not the elements themselves. + * - The IList interface stores just the pointers to the elements in the map and not the elements themselves. * - The specific error code can be accessed using the GetLastResult() method. * @see GetKeysN() */ virtual IList* GetValuesN(void) const = 0; /** - * Removes the value associated with the specified key. + * Removes the value associated to the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key to remove - * @param[in] forceDeletion Set to @c true to deallocate the object, @n - * else @c false + * @param[in] key The key to remove + * @param[in] forceDeletion Set to @c true to deallocate the object, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting. * - Remove(key, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -242,32 +247,33 @@ public: } /** - * Removes the value associated with the specified key. + * Removes the value associated to the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the value is to remove + * @param[in] key The key for which the value is removed * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add(Object*, Object*) */ virtual result Remove(const Object& key) = 0; /** * Removes all the object pointers in the collection. @n - * If the @c forceDeletion parameter is set to @c true, the method also removes all the objects. This method can be called before deleting the collection. + * If @c forceDeletion is set to @c true, the method also removes all the objects. The %RemoveAll() method can be called before deleting the collection. * * @since 2.0 * * @param[in] forceDeletion Set to @c true to deallocate all the objects, @n * else @c false * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting. * - RemoveAll(@b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -301,31 +307,32 @@ public: } /** - * Removes all the object pointers in the collection. @n + * Removes all the object pointers from the collection. @n * * @since 2.0 */ virtual void RemoveAll(void) = 0; /** - * Replaces the value associated with the specified key with the specified value. + * Replaces the value associated to the specified @c key with the specified @c value. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the value is to replace - * @param[in] value The new value + * @param[in] key The key for which the value is replaced + * @param[in] value The new value * @param[in] forceDeletion Set to @c true to deallocate the object, @n * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks * - Use the Add(Object*, Object*) method to add a new key-value pair. - * - Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n - * If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the set operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the set method. @n + * If both the element deleter and the @c forceDeletion are set, the set operation follows the @c forceDeletion setting. * - SetValue(key, value, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -361,17 +368,18 @@ public: } /** - * Replaces the value associated with the specified key with the specified value. + * Replaces the value associated to the specified @c key with the specified @c value. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the value is to replace - * @param[in] pValue The pointer to new value + * @param[in] key The key for which the value is replaced + * @param[in] pValue A pointer to the new value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks Use the Add(Object*, Object*) method to add a new key-value pair. * @see GetValue() */ @@ -379,21 +387,22 @@ public: /** * @if OSPDEPREC - * Checks whether the map contains the specified key. + * Checks whether the map contains the specified @c key. * * @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 into boolean and this method returns the result. * Instead of using this method, use bool ContainsKey(const Object& key). * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[out] out Set to @c true if the map contains the specified key, @n - * else @c false + * @param[in] key The key to locate + * @param[out] out Set to @c true if the map contains the specified key, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsValue() * @endif */ @@ -405,7 +414,7 @@ public: } /** - * Checks whether the map contains the specified key. + * Checks whether the map contains the specified @c key. * * @since 2.0 * @@ -413,15 +422,16 @@ public: * else @c false * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see ContainsValue() */ virtual bool ContainsKey(const Object& key) const = 0; /** - * Checks whether the map contains the specified value. + * Checks whether the map contains the specified @c value. * * @since 2.0 * @@ -434,16 +444,15 @@ public: virtual bool ContainsValue(const Object& value) const = 0; /** - * Gets an instance of the IMapEnumerator for the map. + * Gets an instance of IMapEnumerator for the map. * * @since 2.0 * - * @return IMapEnumerator object of this map, @n + * @return An instance of IMapEnumerator for this map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see IEnumerator - * @see IMapEnumerator */ virtual IMapEnumerator* GetMapEnumeratorN(void) const = 0; diff --git a/inc/FBaseColIMapEnumerator.h b/inc/FBaseColIMapEnumerator.h index ef95d93..91131b2 100644 --- a/inc/FBaseColIMapEnumerator.h +++ b/inc/FBaseColIMapEnumerator.h @@ -33,16 +33,16 @@ class MapEntry; /** * @interface IMapEnumerator - * @brief This interface supports simple iteration over a map. + * @brief This interface supports a simple iteration over a map. * * @since 2.0 * - * @remarks - * An enumerator remains valid as long as the map remains unchanged. - * If changes are made to the map, such as adding, modifying, or - * deleting elements, the enumerator is irrecoverably invalidated. The next call to any method returns an E_INVALID_OPERATION message. + * @remarks An enumerator remains valid as long as the map remains unchanged. @n + * If changes are made to the map, such as adding, modifying, or + * deleting elements, the enumerator is irrecoverably invalidated. @n + * The next call to any method returns @c E_INVALID_OPERATION. * - * The %IMapEnumerator interface supports simple iteration over a map. + * The %IMapEnumerator interface supports a simple iteration over a map. * One can only access the elements in a collection through %IMapEnumerator. The elements cannot be modified through this interface. * * For more information on the class features, see HashMap and MultiHashMap. @@ -61,16 +61,16 @@ public: virtual ~IMapEnumerator(void) {} /** - * Gets the current object from the collection. + * Gets the current object in the collection. * * @since 2.0 * * @return A pointer to the current object in the collection, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. - * @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 - * - The enumerator is currently positioned before the first element or after the last element. @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. + * - The enumerator is currently positioned before the first element or after the last element. * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -84,9 +84,9 @@ public: * @return A pointer to the current key in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. - * @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 - * - The enumerator is currently positioned before the first element or after the last element. @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. + * - The enumerator is currently positioned before the first element or after the last element. * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -100,9 +100,9 @@ public: * @return A pointer to the current value in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. - * @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 - * - The enumerator is currently positioned before the first element or after the last element. @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. + * - The enumerator is currently positioned before the first element or after the last element. * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using the GetLastResult() method. */ diff --git a/inc/FBaseColIMapEnumeratorT.h b/inc/FBaseColIMapEnumeratorT.h index c072465..8f22423 100644 --- a/inc/FBaseColIMapEnumeratorT.h +++ b/inc/FBaseColIMapEnumeratorT.h @@ -31,17 +31,17 @@ namespace Tizen { namespace Base { namespace Collection /** * @interface IMapEnumeratorT - * @brief This interface supports simple iteration over a template-based map. @n + * @brief This interface supports a simple iteration over a template-based map. @n * Using this method, you can only access the elements in the map. You cannot modify the elements. * * @since 2.0 * - * @remarks - * An enumerator remains valid as long as the map remains unchanged. - * If changes are made to the map, such as adding, modifying, or - * deleting elements, the enumerator is irrecoverably invalidated. The next call to any method returns an @c E_INVALID_OPERATION message. + * @remarks An enumerator remains valid as long as the map remains unchanged. @n + * If changes are made to the map, such as adding, modifying, or + * deleting elements, the enumerator is irrecoverably invalidated. @n + * The next call to any method returns @c E_INVALID_OPERATION. * - * The %IMapEnumeratorT interface supports simple iteration over a template-based map. + * The %IMapEnumeratorT interface supports a simple iteration over a template-based map. * Using this method, you can only access the elements in the map. You cannot modify the elements. * * For more information on the class features, see HashMap and MultiHashMap. @@ -67,8 +67,10 @@ public: * * @return An error code * @param[out] key The current key - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n - * The enumerator is currently positioned before the first element or after the last element or the collection is modified after the 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 enumerator is currently positioned before the first element or after the last element. + * - The collection is modified after the enumerator is created. * @exception E_SUCCESS The method is successful. */ virtual result GetKey(KeyType& key) const = 0; @@ -80,8 +82,10 @@ public: * * @return An error code * @param[out] value The current value - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n - * The enumerator is currently positioned before the first element or after the last element or the collection is modified after the 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 enumerator is currently positioned before the first element or after the last element. + * - The collection is modified after the enumerator is created. * @exception E_SUCCESS The method is successful. */ virtual result GetValue(ValueType& value) const = 0; diff --git a/inc/FBaseColIMapT.h b/inc/FBaseColIMapT.h index 7d8ca4d..e74248b 100644 --- a/inc/FBaseColIMapT.h +++ b/inc/FBaseColIMapT.h @@ -34,11 +34,11 @@ template< class Type > class IListT; /** * @interface IMapT - * @brief This interface abstracts a template-based collection of key-value pairs. + * @brief This interface represents a template-based collection of key-value pairs. * * @since 2.0 * - * The %IMapT interface abstracts a template-based collection of key-value pairs. An %IMapT + * The %IMapT interface represents a template-based collection of key-value pairs. An %IMapT * contains unique keys and each key maps to a single value. * The key and value cannot be a @c null reference. * @@ -64,70 +64,73 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key to add - * @param[in] value The corresponding value to add + * @param[in] key The key to add + * @param[in] value The corresponding value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_ALREADY_EXIST The specified @c key already exists. * @see Remove() */ virtual result Add(const KeyType& key, const ValueType& value) = 0; /** - * Gets the value associated with the specified @c key. + * Gets the value associated to the specified @c key. * * @since 2.0 * - * @return The value associated with the specified @c key, @n + * @return The value associated to the specified key, @n * else @c null if an exception occurs - * @param[in] key The key to find the associated value - * @param[out] value The value associated with the key + * @param[in] key The key used to find the associated value + * @param[out] value The value associated to the key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see SetValue() */ virtual result GetValue(const KeyType& key, ValueType& value) const = 0; /** - * Gets the value associated with the specified @c key. + * Gets the value associated to the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key to find the associated value - * @param[out] value The value associated with the key + * @param[in] key The key used to find the associated value + * @param[out] value The value associated to the key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see SetValue() */ virtual result GetValue(const KeyType& key, ValueType& value) = 0; /** - * Gets a list of all the keys in the map. + * Gets the list of all the keys in the map. * * @since 2.0 * - * @return A pointer to a list of all the keys in the map, @n + * @return A pointer to the list of all the keys in the map, @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 order of the keys is the same as the corresponding values in the IListT interface returned by the GetValuesN() method. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see GetValuesN() + * @remarks + * - The order of the keys is the same as the corresponding values in the IListT interface returned by the GetValuesN() method. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IListT< KeyType >* GetKeysN(void) const = 0; /** - * Gets a list of all the values in the map. + * Gets the list of all the values in the map. * * @since 2.0 * - * @return A pointer to a list of all values in the map, @n + * @return A pointer to the list of all values in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -137,41 +140,42 @@ public: virtual IListT< ValueType >* GetValuesN(void) const = 0; /** - * Removes the value associated with the specified @c key. + * Removes the value associated to the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the value is to remove + * @param[in] key The key for which the value is removed * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add() */ virtual result Remove(const KeyType& key) = 0; /** - * Removes all key-value pairs in the map. + * Removes all the key-value pairs in the map. * * @since 2.0 */ virtual void RemoveAll(void) = 0; /** - * Replaces the value associated with the specified @c key with the specified @c value. + * Replaces the value associated to the specified @c key with the specified @c value. * * @since 2.0 * * @return An error code - * @param[in] key The key whose value is to replace - * @param[in] value The new value + * @param[in] key The key whose value is replaced + * @param[in] value The new value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks Use the Add() method to add a new key-value pair. - * @see Add() * @see GetValue() */ virtual result SetValue(const KeyType& key, const ValueType& value) = 0; @@ -182,13 +186,14 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[out] out Set to @c true if the map contains the specified @c key, @n - * else @c false - * @exception E_SUCCESS The method is successful, or - * the map contains the specified @c key. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @param[in] key The key to locate + * @param[out] out The boolean value that indicates if the map contains the specified @c key + * @exception E_SUCCESS Either of the following conditions has occurred: + * - The method is successful. + * - The map contains the specified @c key. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsValue() */ virtual result ContainsKey(const KeyType& key, bool& out) const = 0; @@ -198,7 +203,7 @@ public: * * @since 2.0 * - * @return @c true if the map contains the specified @c value, @n + * @return @c true if the map contains the specified value, @n * else @c false * @param[in] value The value to locate * @@ -207,11 +212,11 @@ public: virtual bool ContainsValue(const ValueType& value) const = 0; /** - * Gets an instance of the IMapEnumeratorT class for the map. + * Gets an instance of IMapEnumeratorT for the map. * * @since 2.0 * - * @return An object of this map, @n + * @return An instance of IMapEnumeratorT for this map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. diff --git a/inc/FBaseColIMultiMap.h b/inc/FBaseColIMultiMap.h index dd5b9e7..78c1803 100644 --- a/inc/FBaseColIMultiMap.h +++ b/inc/FBaseColIMultiMap.h @@ -40,8 +40,8 @@ class MapEntry; * * @since 2.0 * - * The %IMultiMap interface abstracts a collection of key-value pairs. - * There is no limit on the number of elements with the same key, but duplicated elements with the same key are not allowed. + * The %IMultiMap interface represents a collection of key-value pairs. + * There is no limit on the number of elements having the same key, but duplicate elements with the same key are not allowed. * The key and value cannot be a @c null reference. * @n * For more information on the class features, see HashMap and MultiHashMap. @@ -64,18 +64,19 @@ public: * Adds the specified key-value pair to the map. * * @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 Add(Object* pKey, Object* pValue). * @since 2.0 * * @return An error code - * @param[in] key The key to add - * @param[in] value The corresponding value to add + * @param[in] key The key to add + * @param[in] value The corresponding value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_ALREADY_EXIST The specified @c key and @c value already exist. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Remove() * @endif */ @@ -90,13 +91,14 @@ public: * @since 2.0 * * @return An error code - * @param[in] pKey The pointer to key to add - * @param[in] pValue The pointer to corresponding value to add + * @param[in] pKey A pointer to the key to add + * @param[in] pValue A pointer to the corresponding value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_ALREADY_EXIST The specified @c pKey and @c pValue already exist. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Remove() */ virtual result Add(Object* pKey, Object* pValue) = 0; @@ -111,81 +113,84 @@ public: virtual int GetCount(void) const = 0; /** - * Gets the number of values with keys matching the specified key. + * Gets the number of values with keys matching the specified @c key. * * @since 2.0 * * @return The number of values with keys matching the specified key - * @param[in] key The key to locate in the map - * @param[out] count The number of values with keys matching the specified key + * @param[in] key The key to locate in the map + * @param[out] count The number of values with keys matching the specified key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. */ virtual result GetCount(const Object& key, int& count) const = 0; /** - * Gets an enumerator of the values associated with the specified key. + * Gets the enumerator of the values associated with the specified @c key. * * @since 2.0 * - * @return An instance of the IEnumerator derived class with the values associated with the specified key, @n + * @return An instance of the IEnumerator derived class that contains the values associated with the specified key, @n * else @c null if an exception occurs * @param[in] key The key to locate in the map * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual IEnumerator* GetValuesN(const Object& key) const = 0; /** - * Gets a list of all unique keys in the map. + * Gets the list of all the unique keys in the map. * * @since 2.0 * - * @return A pointer to a list of all unique keys in the map, @n + * @return A pointer to the list of all the unique keys in the map, @n * else @c null if an exception occurs * @remarks - * - The %IList stores just the pointers to the elements in the map, not the elements themselves. + * - The IList stores just the pointers to the elements in the map and not the elements themselves. * - The specific error code can be accessed using the GetLastResult() method. * @see GetValuesN() */ virtual IList* GetKeysN(void) const = 0; /** - * Gets a list of all the values in the map. + * Gets the list of all the values in the map. * * @since 2.0 * - * @return A pointer to a list of all the values in the map, @n + * @return A pointer to the list of all the values in the map, @n * else @c null if an exception occurs * @remarks - * - The IList stores just the pointers to the elements in the map, not the elements themselves. + * - The IList stores just the pointers to the elements in the map and not the elements themselves. * - The specific error code can be accessed using the GetLastResult() method. * @see SetValue() */ virtual IList* GetValuesN(void) const = 0; /** - * Removes all the values associated with the specified key. + * Removes all the values associated with the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the associated values need to remove + * @param[in] key The key for which the associated values are removed * @param[in] forceDeletion Set to @c true to deallocate the object, @n * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting. * - Remove(key, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -221,39 +226,41 @@ public: } /** - * Removes all the values associated with the specified key. + * Removes all the values associated with the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the associated values need to remove + * @param[in] key The key for which the associated values are removed * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add(Object*, Object*) */ virtual result Remove(const Object& key) = 0; /** - * Removes the specified value associated with the specified key. @n - * The key is also removed if there are no more values associated with it. + * Removes the specified @c value associated with the specified @c key. @n + * The @c key is also removed if there are no more values associated with it. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the mapping is to remove from the map - * @param[in] value The value to remove + * @param[in] key The key for which the mapping is removed from the map + * @param[in] value The value to remove * @param[in] forceDeletion Set to @c true to deallocate the object, @n * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The @c key and @c value pair is not found in the map. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key and the specified @c value pair has not been found in the map. * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * - The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * - If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting. * - Remove(key, value, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -289,34 +296,35 @@ public: } /** - * Removes the specified value associated with the specified key. @n - * The key is also removed if there are no more values associated with it. + * Removes the specified @c value associated with the specified @c key. @n + * The @c key is also removed if there are no more values associated with it. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the mapping is to remove from the map - * @param[in] value The value to remove + * @param[in] key The key for which the mapping is removed from the map + * @param[in] value The value to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The @c key and @c value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key and the specified @c value pair has not been found in the map. * @see Add(Object*, Object*) */ virtual result Remove(const Object& key, const Object& value) = 0; /** * Removes all the object pointers in the collection. @n - * If the @c forceDeletion parameter is set to @c true, the method also removes all the objects. This method can be called before deleting the collection. + * If @c forceDeletion is set to @c true, the method also removes all the objects. This method can be called before deleting the collection. * * @since 2.0 * * @param[in] forceDeletion Set to @c true to deallocate all objects, @n * else @c false * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * - The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * - If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting. * - RemoveAll(@b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -351,32 +359,33 @@ public: /** * Removes all the object pointers in the collection. @n - * This method can be called before deleting the collection. + * The %RemoveAll() method can be called before deleting the collection. * * @since 2.0 */ virtual void RemoveAll(void) = 0; /** - * Replaces the specified value associated with the specified key with a new value. + * Replaces the specified @c value associated with the specified @c key with a @c newValue. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the associated value needs to replace - * @param[in] value The value associated with the key - * @param[in] newValue The new value - * @param[in] forceDeletion Set to @c true to deallocate the object, @n - * else @c false + * @param[in] key The key for which the associated value is replaced + * @param[in] value The value associated with the key + * @param[in] newValue The new value + * @param[in] forceDeletion Set to @c true to deallocate the object, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The key-value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The key-value pair has not been found in the map. * @remarks * - Use the Add(Object*, Object*) method to add a new key-value pair. - * - Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n - * If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the set operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the set method. @n + * If both the element deleter and the @c forceDeleteion are set, the set operation follows the @c forceDeletion setting. * - SetValue(key, value, newValue, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -412,18 +421,19 @@ public: } /** - * Replaces the specified value associated with the specified key with a new value. + * Replaces the specified @c value associated with the specified @c key with a @c pNewValue. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the associated value needs to replace - * @param[in] value The value associated with the key - * @param[in] pNewValue The pointer to new value + * @param[in] key The key for which the associated value is replaced + * @param[in] value The value associated with the key + * @param[in] pNewValue A pointer to the new value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The key-value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The key-value pair has not been found in the map. * @remarks Use the Add(Object*, Object*) method to add a new key-value pair. * @see GetValuesN() */ @@ -434,19 +444,20 @@ public: * Checks whether the map contains the specified key-value pair. * * @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 into boolean and this method returns the result. * Instead of using this method, use bool Contains(const Object& key, const Object& value). * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[in] value The value to locate - * @param[out] out Set to @c true if the map contains the specified key-value pair, @n - * else @c false + * @param[in] key The key to locate + * @param[in] value The value to locate + * @param[out] out Set to @c true if the map contains the specified key-value pair, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsKey() * @see ContainsValue() * @endif @@ -465,11 +476,12 @@ public: * * @return @c true if the map contains the specified key-value pair, @n * else @c false - * @param[in] key The key to locate - * @param[in] value The value to locate + * @param[in] key The key to locate + * @param[in] value The value to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see ContainsKey(const Object&) const * @see ContainsValue() @@ -478,21 +490,22 @@ public: /** * @if OSPDEPREC - * Checks whether the map contains the specified key. + * Checks whether the map contains the specified @c key. * * @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 into boolean and this method returns the result. * Instead of using this method, use bool ContainsKey(const Object& key). * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[out] out Set to @c true if the map contains the specified key, @n - * else @c false + * @param[in] key The key to locate + * @param[out] out Set to @c true if the map contains the specified key, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsValue() * @see Contains(const Object&, const Object&) * @endif @@ -505,7 +518,7 @@ public: } /** - * Checks whether the map contains the specified key. + * Checks whether the map contains the specified @c key. * * @since 2.0 * @@ -513,8 +526,9 @@ public: * else @c false * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see ContainsValue() * @see Contains(const Object&, const Object&) const @@ -522,7 +536,7 @@ public: virtual bool ContainsKey(const Object& key) const = 0; /** - * Checks whether the map contains the specified value. + * Checks whether the map contains the specified @c value. * * @since 2.0 * @@ -536,11 +550,11 @@ public: virtual bool ContainsValue(const Object& value) const = 0; /** - * Gets an enumerator of the map. + * Gets the enumerator of the map. * * @since 2.0 * - * @return An instance of the IMapEnumerator class for the map, @n + * @return An instance of IMapEnumerator for the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @remarks @@ -548,7 +562,6 @@ public: * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... * - The specific error code can be accessed using the GetLastResult() method. * @see IEnumerator - * @see IMapEnumerator */ virtual IMapEnumerator* GetMapEnumeratorN(void) const = 0; diff --git a/inc/FBaseColIMultiMapT.h b/inc/FBaseColIMultiMapT.h index 1c2a8a4..41f8dea 100644 --- a/inc/FBaseColIMultiMapT.h +++ b/inc/FBaseColIMultiMapT.h @@ -38,8 +38,8 @@ template< class Type > class IListT; * * @since 2.0 * - * The %IMultiMapT interface abstracts a template-based collection of key-value pairs. - * There is no limit on the number of elements with the same key, but duplicated elements with the same key are not allowed. + * The %IMultiMapT interface represents a template-based collection of key-value pairs. + * There is no limit on the number of elements having the same key, but duplicate elements with the same key are not allowed. * The key and value cannot be a @c null reference. * @n * For more information on the class features, see HashMap and MultiHashMap. @@ -64,12 +64,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key to add - * @param[in] value The corresponding value to add + * @param[in] key The key to add + * @param[in] value The corresponding value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_ALREADY_EXIST The specified @c key and @c value already exists. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_ALREADY_EXIST The specified @c key and the specified @c value already exists. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @see Remove() */ @@ -85,32 +86,34 @@ public: virtual int GetCount(void) const = 0; /** - * Gets the number of values whose key matches the specified key. + * Gets the number of values whose key matches the specified @c key. * * @since 2.0 * * @return The number of values whose key matches the specified key - * @param[in] key The key to locate in the map - * @param[out] count The number of values whose key matches the specified key + * @param[in] key The key to locate in the map + * @param[out] count The number of values whose key matches the specified key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. */ virtual result GetCount(const KeyType& key, int& count) const = 0; /** - * Gets an enumerator of the values associated with the specified key. + * Gets the enumerator of the values associated with the specified @c key. * * @since 2.0 * - * @return An instance of the IEnumeratorT derived class with the values associated with the specified key, @n + * @return An instance of the IEnumeratorT derived class that contains the values associated with the specified key, @n * else @c null if an exception occurs * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetValue() @@ -118,11 +121,11 @@ public: virtual IEnumeratorT< ValueType >* GetValuesN(const KeyType& key) const = 0; /** - * Gets a list of all unique keys in the map. + * Gets the list of all the unique keys in the map. * * @since 2.0 * - * @return A pointer to a list of all unique keys in the map, @n + * @return A pointer to the list of all the unique keys in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -132,11 +135,11 @@ public: virtual IListT< KeyType >* GetKeysN(void) const = 0; /** - * Gets a list of all the values in the map. + * Gets the list of all the values in the map. * * @since 2.0 * - * @return A pointer to a list of all the values in the map, @n + * @return A pointer to the list of all the values in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -146,16 +149,17 @@ public: virtual IListT< ValueType >* GetValuesN(void) const = 0; /** - * Removes all the values associated with the specified key. + * Removes all the values associated with the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key whose associated values need to remove + * @param[in] key The key whose associated values are removed * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add() */ virtual result Remove(const KeyType& key) = 0; @@ -167,12 +171,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key whose mapping is to remove from the map - * @param[in] value The value to remove + * @param[in] key The key whose mapping is removed from the map + * @param[in] value The value to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key and the specified @c value pair has not been found in the map. * @see Add() */ virtual result Remove(const KeyType& key, const ValueType& value) = 0; @@ -185,18 +190,19 @@ public: virtual void RemoveAll(void) = 0; /** - * Replaces the specified value associated with the specified key with a new value. + * Replaces the specified @c value associated with the specified @c key with a @c newValue. * * @since 2.0 * * @return An error code - * @param[in] key The key whose associated value needs to replace - * @param[in] value The value associated with the key - * @param[in] newValue The new value + * @param[in] key The key whose associated value is replaced + * @param[in] value The value associated with the key + * @param[in] newValue The new value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key and the specified @c value pair has not been found in the map. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks Use the Add() method to add a new key-value pair. * @see Add() @@ -210,37 +216,39 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[in] value The value to locate - * @param[out] out Set to @c true if the map contains the specified key-value pair, @n - * else @c false - * @exception E_SUCCESS The method is successful. @n - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @param[in] key The key to locate + * @param[in] value The value to locate + * @param[out] out Set to @c true if the map contains the specified key-value pair, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsKey() * @see ContainsValue() */ virtual result Contains(const KeyType& key, const ValueType& value, bool& out) const = 0; /** - * Checks whether the map contains the specified key. + * Checks whether the map contains the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[out] out Set to @c true if the map contains the specified key, @n - * else @c false - * @exception E_SUCCESS The method is successful. @n - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @param[in] key The key to locate + * @param[out] out Set to @c true if the map contains the specified key, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsValue() * @see Contains() */ virtual result ContainsKey(const KeyType& key, bool& out) const = 0; /** - * Checks whether the map contains the specified value. + * Checks whether the map contains the specified @c value. * * @since 2.0 * @@ -254,17 +262,18 @@ public: virtual bool ContainsValue(const ValueType& value) const = 0; /** - * Gets an enumerator of the map. + * Gets the enumerator of the map. * * @since 2.0 * - * @return An instance of the IMapEnumeratorT class for the map, @n + * @return An instance of IMapEnumeratorT for the map, @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 If a key has multiple values, the enumeration proceeds as follows: @n - * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - If a key has multiple values, the enumeration proceeds as follows: @n + * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... + * - The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Base::Collection::IEnumerator * @see Tizen::Base::Collection::IMapEnumerator */ diff --git a/inc/FBaseColIteratorT.h b/inc/FBaseColIteratorT.h index 67ad607..b380468 100644 --- a/inc/FBaseColIteratorT.h +++ b/inc/FBaseColIteratorT.h @@ -36,12 +36,12 @@ namespace Tizen { namespace Base { namespace Collection /** * @class IteratorT * @brief This class provides an iterator that is used to convert %IList to STL containers. @n - * %StlConverter provides static methods to get this iterator from %IList. + * %StlConverter provides static methods to get this iterator from IList. * * @since 2.1 * - * @remarks The %IteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of %Tizen collection. - * So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments. + * @remarks The %IteratorT class satisfies only the requirements of the C++ standard library InputIterator concept due to limitations of the %Tizen collection. @n + * This class can be used with the C++ standard library algorithms which require only the InputIterator concept for their arguments. * * The %IteratorT class provides an iterator that is used to convert IList to STL containers. * StlConverter provides static methods to get this iterator from IList. @@ -53,12 +53,12 @@ class IteratorT { public: /** - * Initializes an instance of %IteratorT class. + * Initializes an instance of %IteratorT. * * @since 2.1 * * @param[in] list A reference to the IList instance to convert - * @param[in] isPostEnd A boolean value to check the end of a list + * @param[in] isPostEnd The boolean value that checks the end of the list */ explicit IteratorT(const IList& list, bool isPostEnd = false) : __pList(&list) @@ -115,7 +115,7 @@ public: } /** - * This is an assignment operator of the %IteratorT class. + * This is the assignment operator of the %IteratorT class. * * @since 2.1 * @@ -130,7 +130,7 @@ public: } /** - * This is the indirection operator for the %IteratorT class. + * This is the indirection operator of the %IteratorT class. * * @since 2.1 * @@ -143,7 +143,7 @@ public: } /** - * This is a structure dereference operator for the %IteratorT class. + * This is the structure dereference operator of the %IteratorT class. * * @since 2.1 * @@ -162,8 +162,9 @@ public: * @return A reference to the %IteratorT type instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the 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 collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ IteratorT< T >& operator ++(void) @@ -193,8 +194,9 @@ CATCH: * @return An %IteratorT instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the 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 collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ IteratorT< T > operator ++(int) @@ -212,8 +214,9 @@ CATCH: * @return A reference to the %IteratorT type instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the 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 collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ IteratorT< T >& operator --(void) @@ -245,8 +248,9 @@ CATCH: * @return An %IteratorT instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the 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 collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ IteratorT< T > operator --(int) diff --git a/inc/FBaseColLinkedList.h b/inc/FBaseColLinkedList.h index e6a24c6..037b60e 100644 --- a/inc/FBaseColLinkedList.h +++ b/inc/FBaseColLinkedList.h @@ -33,11 +33,11 @@ class _ListNode; /** * @class LinkedList - * @brief This class represents a collection of objects that can be individually accessed by index. + * @brief This class represents a collection of objects that can be individually accessed by an index. * * @since 2.0 * - * The %LinkedList class represents a collection of objects that can be individually accessed by index. + * The %LinkedList class represents a collection of objects that can be individually accessed by an index. * * For more information on the class features, see ArrayList and LinkedList. * @@ -107,10 +107,11 @@ public: * * @since 2.0 * - * @param[in] deleter The function pointer to type of the element deleter - * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n - * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter. - * It means that you do not transfer the ownership of elements to the collection. + * @param[in] deleter A function pointer to the type of the element deleter + * @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection destroys the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, as @c NoOpDeleter is the default element deleter. @n + * It means that you do not transfer the ownership of the elements to the collection. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -130,10 +131,10 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj An pointer to object to add + * @param[in] pObj A pointer to the object to add * @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 adds just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Remove() */ virtual result Add(Object* pObj); @@ -144,157 +145,168 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection A collection to add + * @param[in] collection The collection to add * @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 adds 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 adds just the pointer and not the element itself. * @see RemoveItems() */ virtual result AddItems(const ICollection& collection); /** - * Gets an enumerator (an instance of the IEnumerator derived class) to the list. + * Gets the enumerator (an instance of the IEnumerator derived class) of the list. * * @since 2.0 * - * @return An enumerator of the calling list object, @n + * @return The enumerator of the calling list object, @n * else @c null if an exception occurs * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IEnumerator */ virtual IEnumerator* GetEnumeratorN(void) const; /** - * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list. + * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of the list. * * @since 2.0 * * @return An instance of the IBidirectionalEnumerator derived class, @n - * else @c null if some exception occurs - * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) + * else @c null if an exception occurs + * @remarks + * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) * to iterate over a collection (an instance of the IList derived class). - * The specific error code can be accessed using GetLastResult() method. - * @see Tizen::Base::Collection::IBidirectionalEnumerator + * - The specific error code can be accessed using GetLastResult() method. */ virtual IBidirectionalEnumerator* GetBidirectionalEnumeratorN(void) const; /** - * Gets the object at the specified index of the calling list. + * Gets the object at the specified @c index of the calling list. * * @since 2.0 * * @return A pointer to the object at the specified index of the list, @n - * else @c null if the index is not valid + * else @c null if the index is invalid * @param[in] index The index of the object to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetAt() */ virtual const Object* GetAt(int index) const; /** - * Gets the object at the specified index of the calling list. + * Gets the object at the specified @c index of the calling list. * * @since 2.0 * * @return A pointer to the object at the specified index of the list, @n - * else @c null if the index is not valid + * else @c null if the index is invalid * @param[in] index The index of the object to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetAt() */ virtual Object* GetAt(int index); /** - * Gets an IList with the specified range from the calling list object. + * Gets the IList with the specified range from the calling list object. * * @since 2.0 * - * @return An IList pointer if successful, @n + * @return An IList pointer , @n * else @c null if an exception occurs - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. - * @remarks The IList stores just the pointers to the elements in the list, not the elements themselves. - * The specific error code can be accessed using the GetLastResult() method. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is either greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @remarks + * - The IList stores just the pointers to the elements in the list and not the elements themselves. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IList* GetItemsN(int startIndex, int count) const; /** * Searches for an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. */ virtual result IndexOf(const Object& obj, int& index) const; /** - * Searches for an object starting from the specified index. @n - * Gets the index of the object if found. + * Searches for an object starting from the specified @c startIndex. @n + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index for the search @n - * It must be less than the number of elements. - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index for the search @n + * It must be less than the number of elements. + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int startIndex, int& index) const; /** * Searches for an object within the specified range. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int startIndex, int count, int& index) const; /** * Searches for the last occurrence of an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the last occurrence of the specified object + * @param[in] obj The object to locate + * @param[out] index The index of the last occurrence of the specified object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see IndexOf() */ virtual result LastIndexOf(const Object& obj, int& index) const; @@ -305,15 +317,18 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to insert - * @param[in] index The index at which the object must be inserted + * @param[in] pObj A pointer to the object to insert + * @param[in] index The index at which the object is inserted * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is greater than the number of elements or less than @c 0. - * @remarks If the @c index equals to the number of elements, then the new element + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements. + * - The specified @c index is less than @c 0. + * @remarks + * - If the @c index is equal to the number of elements, then the new elements * is added at the end of this list. - * This method performs a shallow copy. It inserts just the pointer; not the element itself. + * - This method performs a shallow copy. It inserts just the pointer and not the element itself. * @see Add() * @see RemoveAt() */ @@ -325,16 +340,20 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to insert elements from - * @param[in] startIndex The starting index at which the elements must be inserted + * @param[in] collection The collection to insert elements from + * @param[in] startIndex The starting index at which the elements are inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c startIndex is either greater than the number of elements or less than @c 0. - * @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 If the @c startIndex equals to the number of elements then the new elements - * are added at the end of this list. - * This method performs a shallow copy. It inserts just the pointer; not the element itself. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c startIndex is greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * @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 + * - If the specified @c startIndex is equal to the number of elements, then the new elements + * are added at the end of this list. + * - This method performs a shallow copy. It inserts just the pointer and not the element itself. * @see RemoveItems() * @see AddItems() */ @@ -346,9 +365,9 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj An object to remove + * @param[in] obj The object to remove * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see Add() * @see RemoveAt() */ @@ -360,27 +379,31 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index at which the object must be removed + * @param[in] index The index at which the object is removed * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * The specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see InsertAt() */ virtual result RemoveAt(int index); /** - * Removes all elements within the specified range from the list. + * Removes all the elements within the specified range from the list. * * @since 2.0 * * @return An error code - * @param[in] startIndex The starting index of the range - * @param[in] count The number of element to remove + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to remove * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * @see AddItems() * @see InsertItemsFrom() */ @@ -395,8 +418,9 @@ public: * @return An error code * @param[in] collection The collection to remove from this list * @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. * @see Remove() * @see RemoveAt() */ @@ -404,7 +428,7 @@ public: /** - * Removes all of the object pointers in the collection and also removes all of the objects depending on the specified element deleter. + * Removes all of the object pointers in the collection and also removes all the objects depending on the specified element deleter. * This method can be called before deleting the objects in a collection. * * @since 2.0 @@ -413,31 +437,34 @@ public: virtual void RemoveAll(void); /** - * Replaces the object at the specified index with the given object. + * Replaces the object at the specified @c index with the given object. * * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to set - * @param[in] index The index at which the object must be set + * @param[in] pObj A pointer to the object to set + * @param[in] index The index at which the object is set * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see GetAt() */ virtual result SetAt(Object* pObj, int index); /** - * Sorts the elements of this list using the comparer provided. + * Sorts the elements of this list using the @c comparer provided. * * @since 2.0 * * @return An error code - * @param[in] comparer The IComparer implementation to use when comparing elements + * @param[in] comparer The IComparer implementation to use when comparing the elements * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the @c comparer is not valid. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c comparer is invalid. */ virtual result Sort(const IComparer& comparer); @@ -463,18 +490,20 @@ public: virtual bool Contains(const Object& obj) const; /** - * Checks whether the list contains all the elements of the specified collection. + * Checks whether the list contains all the elements of the specified @c collection. * * @since 2.0 * - * @return @c true if this list contains all of the elements in the specified collection, @n + * @return @c true if this list contains all the elements in the specified collection, @n * else @c false * @param[in] collection The collection to check for containment in this list * @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 The specific error code can be accessed using the GetLastResult() method. - * @remarks If the given @c collection is empty, this method will return @c true. + * @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. + * - If the given @c collection is empty, this method returns @c true. * @see Contains() */ virtual bool ContainsAll(const ICollection& collection) const; @@ -487,9 +516,10 @@ 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 calling object - * @remarks This method returns @c true only if the specified object is also an instance of the %LinkedList class, + * @remarks + * - This method returns @c true only if the specified object is also an instance of the %LinkedList class, * both lists have the same size, and all corresponding pairs of elements in the two lists are equal. - * In other words, two lists are equal if they contain the same elements in the same order. + * - In other words, two lists are equal if they contain the same elements in the same order. */ virtual bool Equals(const Object& obj) const; @@ -499,8 +529,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; @@ -574,7 +604,7 @@ private: /** * Gets a node from Available node list. * - * @return A pointer to a new List Node if successful, @n + * @return A pointer to a new List Node, @n * else @c null if no node is available */ _ListNode* GetNewNode(void); diff --git a/inc/FBaseColLinkedListT.h b/inc/FBaseColLinkedListT.h index 01c1b71..417b67f 100644 --- a/inc/FBaseColLinkedListT.h +++ b/inc/FBaseColLinkedListT.h @@ -35,11 +35,11 @@ template< class Type > class __LinkedListNodeT; /** * @class LinkedListT - * @brief This class represents a template-based collection of objects that can be individually accessed by index. + * @brief This class represents a template-based collection of objects that can be individually accessed by an index. * * @since 2.0 * - * The %LinkedListT class represents a template-based collection of objects that can be individually accessed by index. + * The %LinkedListT class represents a template-based collection of objects that can be individually accessed by an index. * * For more information on the class features, see ArrayList and LinkedList. * @@ -130,7 +130,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj An object to add + * @param[in] obj The object to add * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @see Remove() @@ -161,10 +161,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection A collection to add + * @param[in] collection The collection to add * @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 RemoveItems() */ virtual result AddItems(const ICollectionT< Type >& collection) @@ -179,16 +180,15 @@ public: } /** - * Gets an enumerator to this list. + * Gets the enumerator of this list. * * @since 2.0 * - * @return An enumerator (an instance of the IEnumeratorT derived class) of this list, @n + * @return The enumerator (an instance of the IEnumeratorT derived class) of this list, @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 { @@ -207,18 +207,18 @@ CATCH: } /** - * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list. + * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list. * * @since 2.0 * - * @return An instance of the IBidirectionalEnumeratorT derived class if successful, @n + * @return An instance of the IBidirectionalEnumeratorT derived class, @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 Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) - * to iterate over a collection (an instance of the IListT derived class). - * The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IBidirectionalEnumeratorT + * @remarks + * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) + * to iterate over a collection (an instance of the IListT derived class). + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IBidirectionalEnumeratorT< Type >* GetBidirectionalEnumeratorN(void) const { @@ -242,11 +242,13 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] index The index of the object to read - * @param[out] obj An object to get from this list + * @param[in] index The index of the object to read + * @param[out] obj The object to get from this list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see SetAt() */ virtual result GetAt(int index, Type& obj) const @@ -269,11 +271,13 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] index The index of the object to read - * @param[out] obj An object to get from this list + * @param[in] index The index of the object to read + * @param[out] obj The object to get from this list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see SetAt() */ virtual result GetAt(int index, Type& obj) @@ -296,14 +300,16 @@ CATCH: * @since 2.0 * * @return A pointer to the IListT derived instance, @n - * else @c null if an exception occurs. - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read + * else @c null if an exception occurs + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. @n + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -363,10 +369,10 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. */ virtual result IndexOf(const Type& obj, int& index) const { @@ -390,14 +396,16 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index for the search @n - * It must be less than the number of elements. - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index for the search @n + * It must be less than the number of elements. + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int startIndex, int& index) const @@ -416,16 +424,18 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int startIndex, int count, int& index) const @@ -464,12 +474,14 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj An object to insert - * @param[in] index The index at which the object must be inserted + * @param[in] obj The object to insert + * @param[in] index The index at which the object is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is greater than the number of elements or less than @c 0. - * @remarks If the @c index equals to the number of elements then the new element + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements. + * - The specified @c index is less than @c 0. + * @remarks If the @c index is equal to the number of elements then the new elements * is added at the end of this list. * @see Add() * @see RemoveAt() @@ -510,19 +522,22 @@ CATCH: /** - * Inserts the elements of the @c collection at the location specified. + * Inserts the elements of the collection at the specified location. * * @since 2.0 * * @return An error code - * @param[in] collection The collection to insert - * @param[in] startIndex The starting index at which the collection must be inserted + * @param[in] collection The collection to insert + * @param[in] startIndex The starting index at which the collection is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c startIndex is either greater than the number of elements or less than @c 0. - * @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. - * @remarks If the @c startIndex equals to the number of elements then the new elements + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * @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 If the @c startIndex is equal to the number of elements then the new elements * are added at the end of this list. * @see RemoveItems() * @see AddItems() @@ -605,10 +620,10 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the last occurrence of the specified object + * @param[in] obj The object to locate + * @param[out] index The index of the last occurrence of the specified object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see IndexOf() */ virtual result LastIndexOf(const Type& obj, int& index) const @@ -635,9 +650,9 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj An object to remove + * @param[in] obj The object to remove * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see Add() * @see RemoveAt() * @see RemoveAll() @@ -661,15 +676,16 @@ CATCH: } /** - * Removes all the elements in the specified @c collection. + * Removes all the elements from the specified collection. * * @since 2.0 * * @return An error code * @param[in] collection The collection to remove from this list * @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 Remove() * @see RemoveAt() */ @@ -720,10 +736,12 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] index The index at which the object must be removed + * @param[in] index The index at which the object is removed * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements. + * - The specified @c index is less than @c 0. * @see InsertAt() */ virtual result RemoveAt(int index) @@ -737,18 +755,20 @@ CATCH: } /** - * Removes all elements within the specified range. + * Removes all the elements within the specified range. * * @since 2.0 * * @return An error code - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * @see AddItems() * @see InsertItemsFrom() */ @@ -809,11 +829,13 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj An object to set - * @param[in] index The index at which the object must be set + * @param[in] obj The object to set + * @param[in] index The index at which the object is set * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see GetAt() */ virtual result SetAt(const Type& obj, int index) @@ -840,8 +862,9 @@ CATCH: * @return An error code * @param[in] comparer The IComparerT implementation to use when comparing the elements * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c comparer is not valid. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c comparer is invalid. */ virtual result Sort(const IComparerT< Type >& comparer) { @@ -910,13 +933,14 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] collection The collection to check for containment in this list - * @param[out] out Set to @c true if this list contains all of the elements in the specified collection, @n - * else @c false + * @param[in] collection The collection to check for containment in this list + * @param[out] out Set to @c true if this list 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. - * @remarks If the given @c collection is empty, the @c out parameter is set to @c true. + * @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 If the given @c collection is empty, then @c out is set to @c true. * @see Contains() */ virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const @@ -977,12 +1001,12 @@ CATCH: * * @since 2.0 * - * @return @c true if the specified instance equals to the current instance, @n + * @return @c true if the specified instance equals the current instance, @n * else @c false * @param[in] obj The object to compare with the calling object - * @remarks This method returns @c true only if the specified object is also an instance of LinkedList class, - * both lists have the same size, and all corresponding pairs of elements in the two lists are equal. - * In other words, two lists are equal if they contain the same elements in the same order. + * @remarks This method returns @c true only if the specified object is also an instance of the LinkedList class, + * both lists have the same size, and all the corresponding pairs of elements in the two lists are equal. @n + * In other words, the two lists are equal if they contain the same elements in the same order. */ virtual bool Equals(const Object& obj) const { @@ -1026,8 +1050,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 { @@ -1326,7 +1350,7 @@ public: * * @since 2.0 * - * @param[in] obj An object to include in this node + * @param[in] obj The object to include in this node */ __LinkedListNodeT(const Type& obj) : pPrev(null) @@ -1374,7 +1398,7 @@ public: * * @since 2.0 * - * @param[in] list A list to enumerate + * @param[in] list The list to enumerate * @param[in] modCount The modification count to detect the change in the list */ __LinkedListEnumeratorT(const LinkedListT< Type >& list, int modCount) @@ -1401,13 +1425,13 @@ public: * @since 2.0 * * @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 + * @param[out] obj The current object + * @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 - - The list is modified after this enumerator is created. - * @exception E_SUCCESS The method is successful. + * past the last element. + * - The list is modified after this enumerator is created. + * @exception E_SUCCESS The method is successful. */ result GetCurrent(Type& obj) const { @@ -1423,15 +1447,16 @@ public: /** * Moves this enumerator to the next element of the list. @n - * When this enumerator is first created or after call to Reset(), + * When this enumerator is first created or after a call to Reset(), * the first call to MoveNext() positions this enumerator to the first element in the list. * * @since 2.0 * * @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 list 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 list is modified after this enumerator is created. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the list. * @see Reset() */ @@ -1464,14 +1489,15 @@ public: } /** - * Positions this enumerator before the first elements in the list. + * Positions this enumerator before the first element in the list. * * @since 2.0 * * @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 list 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 list is modified after this enumerator is created. */ result Reset(void) { diff --git a/inc/FBaseColMapEntry.h b/inc/FBaseColMapEntry.h index 0b29a20..b8f8ff3 100644 --- a/inc/FBaseColMapEntry.h +++ b/inc/FBaseColMapEntry.h @@ -47,7 +47,7 @@ public: * * @since 2.0 * - * @param[in] key The key + * @param[in] key The key * @param[in] value The value */ MapEntry(const Object& key, const Object& value); @@ -100,7 +100,7 @@ public: virtual Object* GetValue(void); /** - * Compares the value of the given Object to the + * Compares the value of the given Tizen::Base::Object to the * value of the calling object. * * @since 2.0 @@ -108,7 +108,7 @@ public: * @return @c true if the values are equal, @n * else @c false * @param[in] obj The object to compare with the calling object - * @remarks Returns @c false if the given object is not a %MapEntry object. + * @remarks This method returns @c false if the given object is not a %MapEntry object. */ virtual bool Equals(const Object& obj) const; @@ -118,8 +118,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; diff --git a/inc/FBaseColMapEntryT.h b/inc/FBaseColMapEntryT.h index 5eb2b3e..677b1be 100644 --- a/inc/FBaseColMapEntryT.h +++ b/inc/FBaseColMapEntryT.h @@ -130,8 +130,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 { diff --git a/inc/FBaseColMultiHashMap.h b/inc/FBaseColMultiHashMap.h index 78e728b..e17272d 100644 --- a/inc/FBaseColMultiHashMap.h +++ b/inc/FBaseColMultiHashMap.h @@ -39,9 +39,9 @@ class _MultiHashMapEntry; * * @since 2.0 * - * The %MultiHashMap class represents a collection of associated keys and values that are organized based on the hash code of the key. - * There is no limit on the number of elements with the same key, but duplicated elements with the same key are not allowed. - * The key and value cannot be @c null. + * The %MultiHashMap class represents a collection of associated keys and values that are organized based on the hash code of the key. + * There is no limit on the number of elements having the same key, but duplicate elements with the same key are not allowed. + * The key and value cannot be a @c null. * @n * For more information on the class features, see HashMap and MultiHashMap. * @@ -114,10 +114,11 @@ public: * * @since 2.0 * - * @param[in] deleter The function pointer to type of the element deleter - * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n - * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter. - * It means that you do not transfer the ownership of elements to the collection. + * @param[in] deleter A function pointer to the type of the element deleter + * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection destroys the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, as @c NoOpDeleter is the default element deleter. @n + * It means that the ownership of the elements is not transferred to the collection. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -132,7 +133,7 @@ public: virtual ~MultiHashMap(void); /** - * Initializes a new instance of %MultiHashMap with the specified capacity and load factor. + * Initializes a new instance of %MultiHashMap with the specified @c capacity and @c loadFactor. * * @since 2.0 * @@ -140,8 +141,9 @@ public: * @param[in] capacity The initial capacity * @param[in] loadFactor The maximum ratio of elements to buckets * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c capacity or the @c loadFactor is negative. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity or the specified @c loadFactor is negative. * @remarks The GetHashCode() method of the key object is used for hashing and the * Equals() method of the key object is used for comparing the keys. * @see MultiHashMap() @@ -149,19 +151,20 @@ public: result Construct(int capacity = 16, float loadFactor = 0.75); /** - * Initializes a new instance of %MultiHashMap by copying the elements of the given map. + * Initializes a new instance of %MultiHashMap by copying the elements of the given @c map. * * @since 2.0 * * @return An error code - * @param[in] map The map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor(0.75) is used. + * @param[in] map The map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor(0.75) is used. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c loadFactor is negative. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map 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 map 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 MultiHashMap() */ result Construct(const IMultiMap& map, float loadFactor = 0.75); @@ -173,17 +176,18 @@ public: * @since 2.0 * * @return An error code - * @param[in] capacity The initial capacity @n - * If it is @c 0, the default capacity (16) is used. - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor (0.75) is used. - * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes - * for all keys in this map - * @param[in] comparer An instance of the IComparer derived class to use when comparing keys + * @param[in] capacity The initial capacity @n + * If it is @c 0, the default capacity (16) is used. + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor (0.75) is used. + * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes + * for all the keys in this map + * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c capacity or the @c loadFactor is negative. - * @remarks The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specfied @c capacity or the specified @c loadFactor is negative. + * @remarks The instances of the hash code provider and the comparer are not deallocated later from this map. * @see MultiHashMap() */ result Construct(int capacity, float loadFactor, const IHashCodeProvider& provider, const IComparer& comparer); @@ -195,19 +199,22 @@ public: * @since 2.0 * * @return An error code - * @param[in] map A map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor (0.75) is used. - * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes - * for all keys in this map - * @param[in] comparer An instance of the IComparer derived class to use when comparing keys + * @param[in] map A map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor (0.75) is used. + * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes + * for all the keys in this map + * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c loadFactor is negative. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map is modified during the operation of this method. - * @remarks This method performs a shallow copy. It copies just the pointer; not the element itself. - * The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c loadFactor is negative. + * @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 map 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. + * - The instances of the hash code provider and the comparer are not deallocated later from this map. * @see MultiHashMap() */ result Construct(const IMultiMap& map, float loadFactor, const IHashCodeProvider& provider, const IComparer& comparer); @@ -218,80 +225,88 @@ public: * @since 2.0 * * @return An error code - * @param[in] pKey The pointer to key to add - * @param[in] pValue The pointer to corresponding value to add + * @param[in] pKey A pointer to the key to add + * @param[in] pValue A pointer to the corresponding value to add * @exception E_SUCCESS The method is successful. * @exception E_OBJ_ALREADY_EXIST The specified pair of @c pKey and @c pValue already exists. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Remove() */ virtual result Add(Object* pKey, Object* pValue); /** - * Gets an enumerator of this map. + * Gets the enumerator of this map. * * @since 2.0 * - * @return An enumerator (an instance of the IEnumerator derived class) of this map, @n - * else @c null if some exception occurs - * @remarks If the key has multiple values, the enumeration proceeds as follows: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... - * The specific error code can be accessed using the GetLastResult() method. - * @see IMapEnumerator + * @return The enumerator (an instance of the IEnumerator derived class) of this map, @n + * else @c null if an exception occurs + * @remarks + * - If the key has multiple values, the enumeration proceeds as follows: + * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... + * - The specific error code can be accessed using the GetLastResult() method. + * @see IMapEnumerator() */ virtual IEnumerator* GetEnumeratorN(void) const; /** - * Gets an enumerator of this map. + * Gets the enumerator of this map. * * @since 2.0 * - * @return An enumerator (an instance of the IMapEnumerator derived class) of this map, @n - * else @c null if some exception occurs - * @remarks If the key has multiple values, the enumeration proceeds as follows: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... - * The specific error code can be accessed using the GetLastResult() method. - * @see IEnumerator + * @return The enumerator (an instance of the IMapEnumerator derived class) of this map, @n + * else @c null if an exception occurs + * @remarks + * - If the key has multiple values, the enumeration proceeds as follows: + * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... + * - The specific error code can be accessed using the GetLastResult() method. + * @see IEnumerator() */ virtual IMapEnumerator* GetMapEnumeratorN(void) const; /** - * Gets an enumerator of the values associated with the specified key. + * Gets the enumerator of the values associated with the specified key. * * @since 2.0 * - * @return An enumerator (an instance of the IEnumerator derived class) of the values associated with the specified key, @n - * else @c null if some exception occurs - * @param[in] key A key to locate + * @return The enumerator (an instance of the IEnumerator derived class) of the values associated with the specified key, @n + * else @c null if an exception occurs + * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetValue() */ virtual IEnumerator* GetValuesN(const Object& key) const; /** - * Gets a list of all unique keys in this map. + * Gets a list of all the unique keys in this map. * * @since 2.0 * - * @return A list of all unique keys in this map - * @remarks The %IList stores just the pointers to the elements in the map, not the elements themselves. - * The specific error code can be accessed using the GetLastResult() method. + * @return The list of all the unique keys in this map + * @remarks + * - The IList stores just the pointers to the elements in the map and not the elements themselves. + * - The specific error code can be accessed using the GetLastResult() method. * @see GetValuesN() */ virtual IList* GetKeysN(void) const; /** - * Gets a list of all the values in this map. + * Gets the list of all the values in this map. * * @since 2.0 * - * @return A list of all the values in this map - * @remarks The IList stores just the pointers to the elements in the map, not the elements themselves. - * The specific error code can be accessed using the GetLastResult() method. + * @return The list of all the values in this map + * @remarks + * - The IList stores just the pointers to the elements in the map and not the elements themselves. + * - The specific error code can be accessed using the GetLastResult() method. * @see GetKeysN() */ virtual IList* GetValuesN(void) const; @@ -304,9 +319,10 @@ public: * @return An error code * @param[in] key The key to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add() */ virtual result Remove(const Object& key); @@ -317,39 +333,41 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key whose mapping is to remove from the map - * @param[in] value The value to remove + * @param[in] key The key whose mapping is removed from the map + * @param[in] value The value to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair has not been found in the map. * @remarks The specified key is also removed if there are no more values associated with it. * @see Add() */ virtual result Remove(const Object& key, const Object& value); /** - * Removes all the object pointers in the @c collection. @n + * Removes all the object pointers in the collection. @n * * @since 2.0 * - * @remarks This method can be called before deleting @c collection. + * @remarks This method can be called before deleting the collection. */ virtual void RemoveAll(void); /** - * Sets the value associated with the given key with a new value. + * Sets the value associated with the given key to a new value. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the associated value needs to replace - * @param[in] value The value to replace - * @param[in] pNewValue The pointer to new value to replace the existing value + * @param[in] key The key for which the associated value is replaced + * @param[in] value The value to replace + * @param[in] pNewValue A pointer to the new value that replaces the existing value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair has not been found in the map. * @remarks To add a new key-value pair, use the Add() method. * @see Add() * @see GetValuesN() @@ -366,32 +384,34 @@ public: virtual int GetCount(void) const; /** - * Gets the number of values whose key matches the key. + * Gets the number of values whose key matches the given key. * * @since 2.0 * * @return An error code - * @param[in] key A key to locate - * @param[out] count The number of values whose key is the @c key + * @param[in] key A key to locate + * @param[out] count The number of values whose key matches the given key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. */ virtual result GetCount(const Object& key, int& count) const; /** - * Checks whether the map contains the specified key and value. + * Checks whether the map contains the specified key and value pair. * * @since 2.0 * * @return @c true if the map contains the specified key and value pair, @n * else @c false - * @param[in] key The key to locate - * @param[in] value The value to locate + * @param[in] key The key to locate + * @param[in] value The value to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see ContainsKey() * @see ContainsValue() @@ -407,8 +427,9 @@ public: * else @c false * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see ContainsValue() * @see Contains() @@ -437,8 +458,8 @@ public: * @return @c true if the two instances are equal, @n * @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 %MultiHashMap class, - * both maps have the same number of elements, and both maps contain the same elements. + * @remarks This method returns @c true only if the specified object is also an instance of the %MultiHashMap class, + * both the maps have the same number of elements, and both the maps contain the same elements. */ virtual bool Equals(const Object& obj) const; @@ -448,8 +469,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; diff --git a/inc/FBaseColMultiHashMapT.h b/inc/FBaseColMultiHashMapT.h index 037a2bb..2e73c31 100644 --- a/inc/FBaseColMultiHashMapT.h +++ b/inc/FBaseColMultiHashMapT.h @@ -45,13 +45,13 @@ template< class ValueType > class __ValueNodeT; /** * @class MultiHashMapT - * @brief This class represents a template-based collection of associated keys and values that are organized based on the hash code of the key. + * @brief This class represents a template-based collection of associated keys and values that are organized based on the hash code of a key. * * @since 2.0 * - * The %MultiHashMapT class represents a template-based collection of associated keys and values that are organized based on the hash code of the key. - * There is no limit on the number of elements with the same key, but duplicated elements with the same key are not allowed. - * The key and value cannot be null. Several methods in the %MultiHashMapT class need an assignment(=) operator of KeyType, and assignment(=) and equivalent(==) operators of ValueType. + * The %MultiHashMapT class represents a template-based collection of associated keys and values that are organized based on the hash code of a key. + * There is no limit on the number of elements having the same key, but duplicate elements with the same key are not allowed. + * The key and value cannot be @c null. Several methods in the %MultiHashMapT class need an assignment(=) operator of KeyType, as well as assignment(=) and equivalent(==) operators of ValueType. * @n * For more information on the class features, see HashMap and MultiHashMap. * @@ -160,11 +160,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] capacity The initial capacity - * @param[in] loadFactor The maximum ratio of elements to buckets - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c capacity or the @c loadFactor is negative. + * @param[in] capacity The initial capacity + * @param[in] loadFactor The maximum ratio of elements to buckets + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity or the specified @c loadFactor is negative. * @remarks The key type must be a primitive data type. * @see MultiHashMapT() */ @@ -233,14 +234,16 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] map A map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor(0.75) is used. + * @param[in] map The map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor(0.75) is used. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c loadFactor is negative. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map is modified during the operation of this method. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid + * - The specified @c loadFactor is negative. + * @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 map is modified during the operation of this method. * @see MultiHashMapT() */ result Construct(const IMultiMapT< KeyType, ValueType >& map, float loadFactor = 0.75) @@ -286,17 +289,18 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] capacity The initial capacity @n - * If it is @c 0, the default capacity(16) is used. - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor(0.75) is used. - * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes - * for all keys in this map - * @param[in] comparer An instance of the IComparer derived class to use when comparing keys + * @param[in] capacity The initial capacity @n + * If it is @c 0, the default capacity(16) is used. + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor(0.75) is used. + * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes + * for all the keys in this map + * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c capacity or the @c loadFactor is negative. - * @remarks The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity or the specified @c loadFactor is negative. + * @remarks The instances of hash code provider and the comparer are not deallocated later from this map. * @see MultiHashMapT() */ result Construct(int capacity, float loadFactor, const IHashCodeProviderT< KeyType >& provider, @@ -361,18 +365,20 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] map A map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor(0.75) is used. - * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes - * for all keys in this map - * @param[in] comparer An instance of the IComparer derived class to use when comparing keys + * @param[in] map The map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor(0.75) is used. + * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes + * for all the keys in this map + * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c loadFactor is negative. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map is modified during the operation of this method. - * @remarks The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c loadFactor is negative. + * @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 map is modified during the operation of this method. + * @remarks The instances of the hash code provider and the comparer are not deallocated later from this map. * @see MultiHashMapT() */ result Construct(const IMultiMapT< KeyType, ValueType >& map, float loadFactor, const IHashCodeProviderT< KeyType >& provider, @@ -415,14 +421,15 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] key A key of the value to add - * @param[in] value A value to add + * @param[in] key The key of the value to add + * @param[in] value The value to add * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_ALREADY_EXIST The specified pair of @c key and @c value already exists. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @remarks SetItem() can be used to set value to a key that does not already exist. - * However, setting a value to a key that already exists overwrites the value. + * @exception E_OBJ_ALREADY_EXIST The specified @c key and @c value pair already exists. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @remarks SetItem() can be used to set a value to a key that does not already exist. @n + * However, setting a value to a key that already exists overwrites this value. * @see Remove() * @see SetValue() */ @@ -497,16 +504,18 @@ CATCH: } /** - * Gets an enumerator of this map. + * Gets the enumerator of this map. * * @since 2.0 * - * @return An enumerator (an instance of the %IMapEnumeratorT derived class) of this map, @n + * @return The enumerator (an instance of the IMapEnumeratorT derived class) of this map, @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 If the key has multiple values, the Enumeration proceeds as follows: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - If the key has multiple values, the enumeration proceeds as follows: @n + * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... + * - The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Base::Collection::IEnumerator * @see Tizen::Base::Collection::IMapEnumerator */ @@ -526,16 +535,18 @@ CATCH: } /** - * Gets an IMapEnumerator of this map. + * Gets the IMapEnumerator of this map. * * @since 2.0 * - * @return An enumerator (an instance of the %IMapEnumeratorT derived class) of this map, @n + * @return The enumerator (an instance of the IMapEnumeratorT derived class) of this map, @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 If the key has multiple values, the Enumeration proceeds like this: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @remarks + * - If the key has multiple values, the enumeration proceeds like this: @n + * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... + * - The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Base::Collection::IEnumerator * @see Tizen::Base::Collection::IMapEnumerator */ @@ -545,17 +556,18 @@ CATCH: } /** - * Gets an enumerator of the values associated with the specified key. + * Gets the enumerator of the values associated with the specified key. * * @since 2.0 * - * @return An enumerator (an instance of the IEnumeratorT derived class) of the values associated with the specified key, @n + * @return The enumerator (an instance of the IEnumeratorT derived class) of the values associated with the specified key, @n * else @c null if an exception occurs - * @param[in] key A key to locate + * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetValue() */ @@ -596,11 +608,11 @@ CATCH: } /** - * Gets a list of all unique keys in this map. + * Gets a list of all the unique keys in this map. * * @since 2.0 * - * @return A list of all unique keys in this map, @n + * @return The list of all the unique keys in this map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -642,7 +654,7 @@ CATCH: * * @since 2.0 * - * @return A list of all the values in this map, @n + * @return The list of all the values in this map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -688,9 +700,10 @@ CATCH: * @return An error code * @param[in] key The key to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add() */ virtual result Remove(const KeyType& key) @@ -748,11 +761,12 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] key The key whose mapping is to remove from the map - * @param[in] value The value to remove + * @param[in] key The key whose mapping is removed from the map + * @param[in] value The value to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map. * @see Add() */ @@ -824,7 +838,7 @@ CATCH: } /** - * Removes all key-value pairs in this map. + * Removes all the key-value pairs in this map. * * @since 2.0 */ @@ -839,20 +853,20 @@ CATCH: } /** - * Replaces the value associated with the key with the specified @c newValue. + * Replaces the value associated with the key, with the specified @c newValue. * * @since 2.0 * * @return An error code - * @param[in] key A key - * @param[in] value A value to replace - * @param[in] newValue A new value to replace the existing value + * @param[in] key The key + * @param[in] value The value to replace + * @param[in] newValue The new value to replace the existing value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map. * @remarks To add a new key-value pair, use the Add() method. - * @see Add() * @see GetValuesN() */ virtual result SetValue(const KeyType& key, const ValueType& value, const ValueType& newValue) @@ -925,11 +939,12 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] key A key to locate - * @param[out] count The number of values whose key is @c key + * @param[in] key The key to locate + * @param[out] count The number of values whose key is @c key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. */ virtual result GetCount(const KeyType& key, int& count) const @@ -971,13 +986,14 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[in] value The value to locate - * @param[out] out Set to @c true if the map contains the specified key and value pair, @n - * else @c false + * @param[in] key The key to locate + * @param[in] value The value to locate + * @param[out] out Set to @c true if the map contains the specified key and value pair, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The current state of the instance prohibits the execution of the specified operation, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The comparer has failed to compare the keys. * @see ContainsKey() * @see ContainsValue() */ @@ -1027,12 +1043,13 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[out] out Set to @c true if the map contains the specified key, @n - * else @c false + * @param[in] key The key to locate + * @param[out] out Set to @c true if the map contains the specified key, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsValue() * @see Contains() */ @@ -1114,7 +1131,7 @@ CATCH: * 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 %MultiHashMapT class, - * both maps have the same number of elements, and both maps contain the same elements. + * both the maps have the same number of elements, and both the maps contain the same elements. */ virtual bool Equals(const Object& obj) const { @@ -1165,8 +1182,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 { @@ -1375,7 +1392,7 @@ public: * * @since 2.0 * - * @param[in] v An object to include in this node + * @param[in] v The object to include in this node */ __ValueNodeT(const ValueType& v) : pNext(null) @@ -1423,11 +1440,11 @@ public: * * @since 2.0 * - * @param[in] keyType A key to include in this entry - * @param[in] list A list of values whose key is specified @n + * @param[in] keyType The key to include in this entry + * @param[in] list The list of values whose key is specified @n * It cannot be @c null. * @param[in] next A pointer to the next entry - * @param[in] h An hash value of the key + * @param[in] h The hash value of the key */ __MultiHashMapEntryT(const KeyType& keyType, __ValueNodeT< ValueType >* list, __MultiHashMapEntryT< KeyType, ValueType >* next, int h) : key(keyType) @@ -1502,7 +1519,7 @@ public: * * @since 2.0 * - * @param[in] map A map to enumerate + * @param[in] map The map to enumerate * @param[in] modCount The modification count to detect the change in the map */ __MultiHashMapEnumeratorT(const MultiHashMapT< KeyType, ValueType >& map, int modCount) @@ -1530,10 +1547,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 map is modified after this enumerator is created. * @exception E_SUCCESS The method is successful. */ @@ -1551,14 +1568,15 @@ public: /** * Moves this enumerator to the next element of the map. @n * After the enumerator is first created or reset using the Reset() method, - * the first call to this method positions the enumerator to the first element in the @c collection. + * the first call to this method positions the enumerator to the first element in the collection. * * @since 2.0 * * @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 map 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 map is modified after this enumerator is created. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the map. * @see Reset() */ @@ -1606,8 +1624,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 map 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 map is modified after this enumerator is created. */ result Reset(void) { @@ -1627,11 +1646,11 @@ public: * * @return An error code * @param[out] key The current key - * @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 - * - The map is modified after this enumerator is created. + * past the last element. @n + * - The map is modified after this enumerator is created. * @exception E_SUCCESS The method is successful. */ result GetKey(KeyType& key) const @@ -1652,10 +1671,10 @@ public: * * @return An error code * @param[out] value The current value - * @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. @n * - The map is modified after the enumerator is created. * @exception E_SUCCESS The method is successful. */ @@ -1695,7 +1714,7 @@ public: * * @since 2.0 * - * @param[in] entry An entry to enumerate + * @param[in] entry The entry to enumerate * @param[in] modCount The modification count to detect the change in the entry */ __EntryValueEnumeratorT(const __MultiHashMapEntryT< KeyType, ValueType >& entry, int modCount) @@ -1722,10 +1741,10 @@ public: * * @return An error code * @param[out] obj The current value - * @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 entry is modified after this enumerator is created. * @exception E_SUCCESS The method is successful. */ @@ -1748,8 +1767,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 entry 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 entry is modified after this enumerator is created. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the entry. * @see Reset() */ @@ -1784,8 +1804,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 entry 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 entry is modified after this enumerator is created. */ result Reset(void) { diff --git a/inc/FBaseColPairIteratorT.h b/inc/FBaseColPairIteratorT.h index 037fa3e..1118e39 100644 --- a/inc/FBaseColPairIteratorT.h +++ b/inc/FBaseColPairIteratorT.h @@ -42,8 +42,8 @@ namespace Tizen { namespace Base { namespace Collection * * @since 2.1 * - * @remarks The %PairIteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of %Tizen Collection. - * So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments. + * @remarks The %PairIteratorT class satisfies only requirements of the C++ standard library InputIterator concept due to the limitations of the %Tizen Collection. @n + * This class can be used with the C++ standard library algorithms which require only the InputIterator concept for their arguments. * * The %PairIteratorT class provides an iterator that is used to convert IMap or IMultiMap to STL containers. * StlConverter provides static methods to get this iterator from IMap or IMultiMap. @@ -55,12 +55,12 @@ class PairIteratorT { public: /** - * Initializes this instance of %PairIteratorT class. + * Initializes this instance of the %PairIteratorT class. * * @since 2.1 * * @param[in] map A reference to the IMap instance to convert - * @param[in] isPostEnd A boolean value to check the end + * @param[in] isPostEnd The boolean value to check the end of the @c map */ explicit PairIteratorT(const IMap& map, bool isPostEnd = false) : __pMap(&map) @@ -91,12 +91,12 @@ public: } /** - * Initializes this instance of %PairIteratorT class. + * Initializes this instance of the %PairIteratorT class. * * @since 2.1 * * @param[in] multiMap A reference to the IMultiMap instance to convert - * @param[in] isPostEnd A boolean value to check the end + * @param[in] isPostEnd The boolean value to check the end of the @c multiMap */ PairIteratorT(const IMultiMap& multiMap, bool isPostEnd = false) : __pMap(null) @@ -134,8 +134,9 @@ public: * @param[in] rhs A reference to the %PairIteratorT instance * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG Both @c __pMap and @c __pMultiMap are @c null. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the 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 collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ PairIteratorT(const PairIteratorT< K, V >& rhs) @@ -166,7 +167,7 @@ public: } /** - * This is assignment operator of the %PairIteratorT class. + * This is the assignment operator of the %PairIteratorT class. * * @since 2.1 * @@ -174,8 +175,9 @@ public: * @param[in] rhs A reference to the %PairIteratorT instance on the right-hand side of the operator * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG Both @c __pMap and @c __pMultiMap are @c null. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the 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 collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ PairIteratorT< K, V >& operator =(const PairIteratorT< K, V >& rhs) @@ -190,7 +192,7 @@ public: * * @since 2.1 * - * @return A std::pair type reference with K and V type + * @return A std::pair type reference with K and V types */ std::pair< K, V >& operator *(void) const { @@ -199,7 +201,7 @@ public: } /** - * This is the const version structure dereference operator for the %PairIteratorT class. + * This is the constant version structure dereference operator for the %PairIteratorT class. * * @since 2.1 * @@ -218,8 +220,9 @@ public: * @return A reference to the %PairIteratorT instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the collection. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the 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 collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ PairIteratorT< K, V >& operator ++(void) @@ -248,8 +251,9 @@ CATCH: * @return A %PairIteratorT instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the collection. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the 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 collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ PairIteratorT< K, V > operator ++(int) diff --git a/inc/FBaseColQueue.h b/inc/FBaseColQueue.h index 83f353a..cafe6d1 100644 --- a/inc/FBaseColQueue.h +++ b/inc/FBaseColQueue.h @@ -100,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,9 +121,10 @@ 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 @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); @@ -135,8 +137,9 @@ 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(Object*) */ @@ -147,7 +150,7 @@ 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 * @@ -155,7 +158,7 @@ public: * @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. + * @remarks This method performs a shallow copy. It inserts just the pointer and not the element itself. * @see Dequeue() * @endif */ @@ -170,42 +173,42 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to add to this queue + * @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. + * @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 * @@ -240,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 @@ -270,8 +274,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 @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; @@ -284,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; @@ -296,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; 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) { diff --git a/inc/FBaseColRandomIteratorT.h b/inc/FBaseColRandomIteratorT.h index cdfae6d..ad9b725 100644 --- a/inc/FBaseColRandomIteratorT.h +++ b/inc/FBaseColRandomIteratorT.h @@ -35,12 +35,12 @@ namespace Tizen { namespace Base { namespace Collection /** * @class RandomIteratorT * @brief This class provides a random iterator that is used to convert %IList to STL containers. @n - * %StlConverter provides static methods to get this random iterator from %IList. + * %StlConverter provides static methods to get this random iterator from IList. * * @since 2.1 * - * @remarks The %RandomIteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of %Tizen collection. - * So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments. + * @remarks The %RandomIteratorT class satisfies only the requirements of the C++ standard library InputIterator concept due to the limitations of the %Tizen collection. @n + * This class can be used with the C++ standard library algorithms which require only the InputIterator concept for their arguments. * * The %RandomIteratorT class provides a random iterator that is used to convert IList to STL containers. * StlConverter provides static methods to get this random iterator from IList. @@ -57,8 +57,8 @@ public: * @since 2.1 * * @param[in] list A reference to the IList instance to convert - * @param[in] index A start index - * @remarks %RandomIteratorT only supports random accessible collection for performance. + * @param[in] index The starting index + * @remarks %RandomIteratorT only supports random accessible collection for its performance. * @see Tizen::Base::Collection::IList::IsRandomAccessible() */ explicit RandomIteratorT(const IList& list, int index = 0) @@ -130,8 +130,10 @@ public: * * @return A reference to the %RandomIteratorT instance * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, - * or the specified index is either equal to or greater than the number of elements in the list or less than 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ RandomIteratorT< T >& operator ++(void) @@ -151,8 +153,10 @@ public: * * @return A %RandomIteratorT instance * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, - * or the specified index is either equal to or greater than the number of elements in the list or less than 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ RandomIteratorT< T > operator ++(int) @@ -163,14 +167,16 @@ public: } /** - * Decrease __index by 1. + * Decreases __index by 1. * * @since 2.1 * * @return A reference to the %RandomIteratorT instance * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, - * or the specified index is either equal to or greater than the number of elements in the list or less than 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ RandomIteratorT< T >& operator --(void) @@ -184,14 +190,16 @@ public: } /** - * Decrease __index by 1 and returns the previous state. + * Decreases __index by 1 and returns the previous state. * * @since 2.1 * * @return A %RandomIteratorT instance * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, - * or the specified index is either equal to or greater than the number of elements in the list or less than 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ RandomIteratorT< T > operator --(int) @@ -230,11 +238,11 @@ public: } /** - * Checks l-value is less than r-value. + * Checks whether the l-value is less than the r-value. * * @since 2.1 * - * @return @c true if l-value of the specified %RandomIteratorT instance is less than the calling instance's members, @n + * @return @c true if the l-value of the specified %RandomIteratorT instance is less than the calling instance's members, @n * else @c false * @param[in] rhs A reference to the %RandomIteratorT instance on the right-hand side of the operator */ @@ -244,11 +252,11 @@ public: } /** - * Checks whether l-value is greater than r-value. + * Checks whether the l-value is greater than the r-value. * * @since 2.1 * - * @return @c true if l-value of the specified %RandomIteratorT instance is greater than the calling instance's members, @n + * @return @c true if the l-value of the specified %RandomIteratorT instance is greater than the calling instance's members, @n * else @c false * @param[in] rhs A reference to the %RandomIteratorT instance on the right-hand side of the operator */ @@ -258,15 +266,17 @@ public: } /** - * Increases __index as specified by the diff parameter. + * Increases __index as specified by the @c diff parameter. * * @since 2.1 * * @return A %RandomIteratorT instance * @param[in] diff The length to move forward * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, - * or the specified index is either equal to or greater than the number of elements in the list or less than 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ RandomIteratorT< T > operator +(int diff) @@ -281,15 +291,17 @@ public: } /** - * Decrease __index as specified by the diff parameter. + * Decreases __index as specified by the @c diff parameter. * * @since 2.1 * * @return A %RandomIteratorT instance * @param[in] diff The length to move backward * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, - * or the specified index is either equal to or greater than the number of elements in the list or less than 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ RandomIteratorT< T > operator -(int diff) @@ -314,10 +326,12 @@ public: * @since 2.1 * * @return A reference to the T type instance - * @param[in] index An index to reach + * @param[in] index The index to reach * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, - * or the specified index is either equal to or greater than the number of elements in the list or less than 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ T& operator [](int index) const @@ -329,7 +343,7 @@ public: } /** - * Swaps values of the two %RandomIteratorT instances. + * Swaps the values of the two %RandomIteratorT instances. * * @since 2.1 * 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; 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. */ diff --git a/inc/FBaseColStlConverter.h b/inc/FBaseColStlConverter.h index 819b18b..5b65d1f 100644 --- a/inc/FBaseColStlConverter.h +++ b/inc/FBaseColStlConverter.h @@ -206,23 +206,24 @@ public: } /** - * Gets an ArrayList instance from the begin and end iterators of STL container. + * Gets an ArrayList instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the ArrayList instance, @n - * else @c std::unique_ptr< ArrayList >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< ArrayList >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the type of the element deleter * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. - * This gives the collection the ownership of elements and the collection can destroy elements. @n - * On the other hand, to create a non-owning collection, you don't need to set the element deleter value, - * as @c NoOpDeleter is the default element deleter. - * That implies transfer of the ownership of elements to the collection is not required. - * @remarks The specific error code can be accessed using GetLastResult() method. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -250,23 +251,24 @@ public: } /** - * Gets a LinkedList instance from the begin and end iterators of STL container. + * Gets a LinkedList instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the LinkedList instance @n - * else @c std::unique_ptr< LinkedList >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< LinkedList >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the type of the element deleter * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. - * This gives the collection the ownership of elements and the collection will destroy elements. @n - * On the other hand, to create a non-owning collection, you don't need to set the element deleter value, - * as @c NoOpDeleter is the default element deleter. - * That implies transfer of the ownership of elements to the collection is not required. - * @remarks The specific error code can be accessed using GetLastResult() method. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -291,23 +293,24 @@ public: } /** - * Gets a HashMap instance from the begin and end iterators of STL container. + * Gets a HashMap instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the HashMap instance @n - * else @c std::unique_ptr< HashMap >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< HashMap >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the type of the element deleter * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. - * This gives the collection the ownership of elements and the collection will destroy elements. @n - * On the other hand, to create a non-owning collection, you don't need to set the element deleter value, - * as @c NoOpDeleter is the default element deleter. - * That implies transfer of the ownership of elements to the collection is not required. - * @remarks The specific error code can be accessed using GetLastResult() method. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -335,23 +338,24 @@ public: } /** - * Gets a MultiHashMap instance from the begin and end iterators of STL container. + * Gets a MultiHashMap instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the MultiHashMap instance @n - * else @c std::unique_ptr< MultiHashMap >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< MultiHashMap >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the type of the element deleter * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. - * This gives the collection the ownership of elements and the collection will destroy elements. @n - * On the other hand, to create a non-owning collection, you don't need to set the element deleter value, - * as @c NoOpDeleter is the default element deleter. - * That implies transfer of the ownership of elements to the collection is not required. - * @remarks The specific error code can be accessed using GetLastResult() method. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() diff --git a/inc/FBaseColTypes.h b/inc/FBaseColTypes.h index 6df2832..24607d7 100644 --- a/inc/FBaseColTypes.h +++ b/inc/FBaseColTypes.h @@ -19,7 +19,7 @@ * @brief This is the header file for the element deleter. * * This header file contains the declarations of the element deleter. - * Depending on the element deleter, collection decides whether to remove the object or not. + * Depending on the element deleter, the collection decides whether to remove the object or not. */ #ifndef _FBASE_COL_TYPES_H_ #define _FBASE_COL_TYPES_H_ @@ -32,29 +32,29 @@ namespace Tizen { namespace Base { namespace Collection typedef void (*DeleterFunctionType)(Object* pObj); /** - * This function does not remove the object. + * Does not remove the object. * * @since 2.0 * - * @param[in] pObj The pointer to the object to remove + * @param[in] pObj A pointer to the object to remove */ _OSP_EXPORT_ void NoOpDeleter(Object* pObj); /** - * This function removes the single object. + * Removes the single object. * * @since 2.0 * - * @param[in] pObj The pointer to the object to remove + * @param[in] pObj A pointer to the object to remove */ _OSP_EXPORT_ void SingleObjectDeleter(Object* pObj); /** - * This function removes the array object. + * Removes the array object. * * @since 2.0 * - * @param[in] pObj The pointer to the object to remove + * @param[in] pObj A pointer to the object to remove */ _OSP_EXPORT_ void ArrayDeleter(Object* pObj); diff --git a/inc/FBaseComparerT.h b/inc/FBaseComparerT.h index cb597e1..176c3d3 100644 --- a/inc/FBaseComparerT.h +++ b/inc/FBaseComparerT.h @@ -31,10 +31,10 @@ namespace Tizen { namespace Base /** * @class ComparerT * - * @brief This class checks for equivalence between 2 values of the same primitive type. + * @brief This class checks for equivalence between two values of the same primitive type. * @since 2.0 * - * The %ComparerT class checks for equivalence between 2 values of the same primitive type. + * The %ComparerT class checks for equivalence between two values of the same primitive type. * * The following example demonstrates how to use the %ComparerT class. * @@ -88,16 +88,16 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj1 The first object to compare - * @param[in] obj2 The second object to compare - * @param[out] cmp The result of comparison + * @param[in] obj1 The first object to compare + * @param[in] obj2 The second object to compare + * @param[out] cmp The result of the comparison * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified objects are not of the expected type. * @remarks @c cmp can take one of the following values: * @code - * < 0 if the value of @c obj1 is less than the value of @c obj2 - * == 0 if the value of @c obj1 is equal to the value of @c obj2 - * > 0 if the value of @c obj1 is greater than the value of @c obj2 + * < 0 if the value of obj1 is less than the value of obj2 + * == 0 if the value of obj1 is equal to the value of obj2 + * > 0 if the value of obj1 is greater than the value of obj2 * @endcode */ virtual result Compare(const Type& obj1, const Type& obj2, int& cmp) const @@ -152,14 +152,14 @@ public: virtual ~ComparerT(void) { } /** - * Compare two String instances. + * Compares two String instances. * * @since 2.1 * - * @return Always returns E_SUCCESS + * @return Always returns @c E_SUCCESS * @param[in] str1 The String instance to compare * @param[in] str2 The String instance to compare - * @param[in] cmp An integer value for result + * @param[in] cmp The integer value for the result */ virtual result Compare(const Tizen::Base::String& str1, const Tizen::Base::String& str2, int& cmp) const {