From: dahyeong.kim Date: Wed, 17 Jul 2013 13:15:26 +0000 (+0900) Subject: [devel_3.0_main] Cherry-pick Beautification of appfw/inc soure-code. 80665 X-Git-Tag: accepted/tizen/20130912.081851^2~104^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=851cb906a7b33299709f32d7371c46577e853d36;p=platform%2Fframework%2Fnative%2Fappfw.git [devel_3.0_main] Cherry-pick Beautification of appfw/inc soure-code. 80665 Change-Id: I4c64bb229ee848d432f56f301ca7cf6834117331 Signed-off-by: dahyeong.kim --- diff --git a/inc/FBaseBoolean.h b/inc/FBaseBoolean.h index b6f0842..7c51f03 100644 --- a/inc/FBaseBoolean.h +++ b/inc/FBaseBoolean.h @@ -72,7 +72,7 @@ public: * * @since 2.0 * - * @param[in] value The input @c bool value to initialize the %Boolean instance + * @param[in] value The input @c bool value to initialize the %Boolean instance */ Boolean(bool value); @@ -81,18 +81,18 @@ public: * * @since 2.0 * - * @param[in] value An instance of the %Boolean class + * @param[in] value An instance of the %Boolean class */ 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, + * If the input is "true" (ignoring case), the object is initialized to @c true, * else @c false. * * @since 2.0 * - * @param[in] value An instance of String + * @param[in] value An instance of String */ Boolean(const String& value); @@ -109,7 +109,7 @@ public: * @since 2.0 * * @return @c true if the values of the objects are equal, @n - * else @c false. + * else @c false. * @param[in] rhs An instance of %Boolean to compare with the current instance */ bool operator ==(const Boolean& rhs) const; @@ -120,7 +120,7 @@ public: * @since 2.0 * * @return @c true if the values of the objects are not equal, @n - * else @c false + * else @c false * @param[in] rhs An instance of %Boolean to compare with the current instance */ bool operator !=(const Boolean& rhs) const; @@ -141,7 +141,7 @@ public: * @since 2.0 * * @return @c true if the value of @c obj matches the value of the calling %Boolean instance, @n - * else @c false + * else @c false * @param[in] obj A reference to the Object instance to compare with the calling %Boolean instance * @see Tizen::Base::Object::Equals() */ @@ -153,8 +153,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. For better performance, @n + * the used hash function must generate a random distribution for all inputs. */ virtual int GetHashCode(void) const; @@ -165,7 +165,7 @@ public: * @since 2.0 * * @return @c true if the parameter matches the calling %Boolean instance, @n - * else @c false + * else @c false * @param[in] value The @c bool value to compare to this instance */ bool Equals(bool value) const; @@ -185,7 +185,7 @@ 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. @@ -204,8 +204,8 @@ public: * @since 2.0 * * @return @c true if the value of the specified string is "true", @n - * else @c false - * @param[in] s An instance of String + * 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. @@ -223,7 +223,7 @@ public: * @since 2.0 * * @return @c true if this instance is @c true, @n - * else @c false + * else @c false */ String ToString(void) const; @@ -235,7 +235,7 @@ public: * @since 2.0 * * @return @c true if the parameter is @c true, @n - * else @c false + * else @c false * @param[in] value A @c bool value to convert to String */ static String ToString(bool value); @@ -269,7 +269,7 @@ public: private: friend class _BooleanImpl; - class _BooleanImpl * __pBooleanImpl; + class _BooleanImpl* __pBooleanImpl; }; // Boolean diff --git a/inc/FBaseBuffer.h b/inc/FBaseBuffer.h index d52ce3a..a3476c8 100644 --- a/inc/FBaseBuffer.h +++ b/inc/FBaseBuffer.h @@ -20,7 +20,6 @@ * * This header file contains the declarations of the %Buffer classes. */ - #ifndef _FBASE_BUFFER_H_ #define _FBASE_BUFFER_H_ @@ -51,11 +50,11 @@ class ByteBuffer; * The following example demonstrates how to use the %Buffer class. * * @code - * + * * #include * * using namespace Tizen::Base; - * + * * void * MyClass::BufferSample(void) * { @@ -67,7 +66,7 @@ class ByteBuffer; * intBuf.Construct(BUFFER_SIZE_MAX); * * int intArray[] = {0,1,2,3,4,5,6,7,8,9}; - * + * * // Copies all values from intArray to intBuffer instance * // position = 10 (num of element copied) * intBuf.SetArray(intArray, 0, (sizeof(intArray) / sizeof(int))); @@ -75,46 +74,46 @@ class ByteBuffer; * // Flips the buffer: The limit is set to the current position and * // then the position is set to zero * intBuf.Flip(); // position = 0, limit = 10 - * + * * // Gets the number of elements between the current position and the limit * int remaining = intBuf.GetRemaining(); - * + * * // Initializes a doubleBuf with capacity(10) using Construct() method * DoubleBuffer doubleBuf; * doubleBuf.Construct(remaining); - * + * * // Reads and writes elements from the intBuf to the doubleBuf * for (int i = 0; i < remaining; i++) * { * int value; * * // Demonstrates relative reading and writing - * + * * // Reads the value at the current position, and then increments the position * intBuf.Get(value); - * + * * // Writes the value * 12.34 at the current position of the doubleBuf * // and then increment the position * doubleBuf.Set(value * 12.34); - * + * * // Now, positions of the intBuf and the doubleBuf have been incremented by one * } - * + * * // Flips the doubleBuf * doubleBuf.Flip(); * // Now, the doubleBuf's position = 0 and limit = 10 - * + * * // Gets the remaining elements of the doubleBuf * remaining = doubleBuf.GetRemaining(); - * + * * // Gets the second double value with index * double doubleValue; * doubleBuf.Get(1, doubleValue); // 12.34 * } - * + * * @endcode */ -template +template< class Type > class _OSP_EXPORT_ Buffer : public BufferBase { @@ -151,13 +150,13 @@ public: * * @since 2.0 * - * @param[in] buffer The other %Buffer instance + * @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. * @see Buffer() */ - result Construct(const Buffer & buffer) + result Construct(const Buffer< Type >& buffer) { TryReturn(null != buffer._pData, E_INVALID_ARG, ("[E_INVALID_ARG] The source buffer is not constructed.")); @@ -179,7 +178,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] capacity The number of elements + * @param[in] capacity The number of elements * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c capacity is negative. * @see Buffer() @@ -194,21 +193,21 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] pBuffer The buffer which is shared - * @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] 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. + * @return An error code + * @param[in] pBuffer The buffer which is shared + * @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] 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. */ result Construct(const Type* pBuffer, int index, int length, int capacity) { TryReturn(pBuffer != null, E_INVALID_ARG, "[E_INVALID_ARG] The pBuffer is null."); - TryReturn(index >= 0 && length >= 0 && capacity >=0, E_OUT_OF_RANGE, + TryReturn(index >= 0 && length >= 0 && capacity >= 0, E_OUT_OF_RANGE, "[E_OUT_OF_RANGE] index(%d), length(%d) and capacity(%d) MUST be greater than or equal to 0.", index, length, capacity); TryReturn(index < capacity && length <= capacity && index + length <= capacity, E_OUT_OF_RANGE, @@ -218,14 +217,14 @@ public: void* pTemp = null; int sizeofBufferData = sizeof(_BufferData); - Type* tempByte = const_cast (pBuffer + index); - __pArrayStart = reinterpret_cast (tempByte); + Type* tempByte = const_cast< Type* >(pBuffer + index); + __pArrayStart = reinterpret_cast< byte* >(tempByte); pTemp = malloc(sizeofBufferData); TryReturn(pTemp != null, E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY]"); memset(pTemp, 0, sizeofBufferData); - _pData = static_cast <_BufferData*>(pTemp); + _pData = static_cast< _BufferData* >(pTemp); _pData->refCount = 1; _pData->capacityInByte = capacity * sizeof(Type); @@ -243,7 +242,7 @@ public: * * @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 { @@ -259,13 +258,13 @@ public: * @since 2.0 * * @return @c true if the buffers being compared are equal, @n - * else @c false + * 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 + * @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). - * @see Equals() + * @see Equals() */ - bool operator ==(const Buffer & buffer) const + bool operator ==(const Buffer< Type >& buffer) const { bool r = true; if (this == (void*) (&buffer)) @@ -295,14 +294,14 @@ public: * @since 2.0 * * @return @c true if the buffers are not equal, @n - * else @c false + * 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 + * @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). - * @see Equals() + * @see Equals() */ - bool operator !=(const Buffer & buffer) const + bool operator !=(const Buffer< Type >& buffer) const { return !(*this == buffer); } @@ -325,7 +324,7 @@ public: * @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. - * @remarks After the copy operation, the current (destination) buffer's position and the given + * @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, @@ -383,15 +382,15 @@ public: * } * @endcode */ - result CopyFrom(Buffer& buffer) + result CopyFrom(Buffer< Type >& buffer) { - TryReturn(this != static_cast (&buffer), E_INVALID_ARG, + TryReturn(this != static_cast< void* >(&buffer), E_INVALID_ARG, "[E_INVALID_ARG] The source and target buffers are identical."); int copyLength = buffer.GetRemaining(); TryReturn(GetRemaining() >= copyLength, E_OVERFLOW, "[E_OVERFLOW]"); memcpy(__pArrayStart + _position * sizeof(Type), buffer.__pArrayStart + buffer._position * sizeof(Type), - copyLength * sizeof(Type)); + copyLength * sizeof(Type)); _position += copyLength; buffer._position += copyLength; @@ -406,11 +405,11 @@ public: * @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. - * @see Set() + * The current position is greater than the limit. + * @see Set() */ result Get(Type& value) { @@ -428,11 +427,11 @@ public: * * @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 + * @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. - * @see Set() + * The @c index is greater than the limit or less than @c 0. + * @see Set() */ result Get(int index, Type& value) const { @@ -461,7 +460,7 @@ public: * 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. + * @remarks After the copy operation, the position is incremented by @c length. * @see SetArray() */ result GetArray(Type* pArray, int index, int length) @@ -488,10 +487,10 @@ public: * @return An error code * @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_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. - * @remarks After the copy operation, the current (destination) buffer's position and the given + * @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 * 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, @@ -556,15 +555,15 @@ public: * } * @endcode */ - result ReadFrom(Buffer& buffer) + result ReadFrom(Buffer< Type >& buffer) { - TryReturn(this != static_cast (&buffer), E_INVALID_ARG, + TryReturn(this != static_cast< void* >(&buffer), E_INVALID_ARG, "[E_INVALID_ARG] The source and target buffers are identical."); int copyLength = (GetRemaining() < buffer.GetRemaining()) ? GetRemaining() : buffer.GetRemaining(); memcpy(__pArrayStart + _position * sizeof(Type), buffer.__pArrayStart + buffer._position * sizeof(Type), - copyLength * sizeof(Type)); + copyLength * sizeof(Type)); _position += copyLength; buffer._position += copyLength; @@ -578,7 +577,7 @@ public: * and then increments the position. @n * Provides a way for relative indexing and writing. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] value The value to write to the calling %Buffer @@ -604,7 +603,7 @@ public: * @return An error code * @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_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. * @see Get() @@ -635,7 +634,7 @@ public: * 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, + * @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. * After the copy operation, the position is incremented by @c length. @@ -662,14 +661,14 @@ public: * @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. + * @remarks The content of the new buffer starts at the current position of this instance of %Buffer. * 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. */ - Buffer * SliceN(void) const + Buffer< Type >* SliceN(void) const { - Buffer * pBuffer = new Buffer (); + Buffer< Type >* pBuffer = new Buffer< Type >(); pBuffer->_pData = _pData; AddRef(); pBuffer->_capacity = GetRemaining(); @@ -703,7 +702,7 @@ public: * @return @c true if the input equals the calling %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, + * @remarks This method returns @c true if and only if the specified object is also an instance of %Buffer class, * 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). * @see Tizen::Base::BufferBase::GetHashCode() @@ -711,7 +710,7 @@ public: virtual bool Equals(const Tizen::Base::Object& obj) const { bool out = false; - const Buffer * other = static_cast *>(&obj); + const Buffer< Type >* other = static_cast< const Buffer< Type >* >(&obj); if ((other == this) || (*other == *this)) { out = true; @@ -726,7 +725,7 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @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. */ virtual int GetHashCode(void) const { @@ -736,7 +735,7 @@ public: int offset = _position * GetTypeSize(); for (int i = 0; i < len; ++i) { - hash = (hash<<5) - hash + (int) __pArrayStart[offset + (i * sizeof(int))]; + hash = (hash << 5) - hash + (int) __pArrayStart[offset + (i * sizeof(int))]; } return hash; @@ -746,7 +745,7 @@ private: /** * This is the copy constructor for this class. */ - Buffer(const Buffer & buffer) + Buffer(const Buffer< Type >& buffer) { Construct(buffer); } @@ -754,7 +753,7 @@ private: /** * This is the assignment operator. */ - Buffer & operator =(const Buffer & buffer); + Buffer< Type >& operator =(const Buffer< Type >& buffer); /** * Returns the size of the type of this buffer. @@ -775,53 +774,53 @@ private: * The @c double buffer type * @since 2.0 */ -typedef Buffer DoubleBuffer; +typedef Buffer< double > DoubleBuffer; /** * The @c float buffer type * @since 2.0 */ -typedef Buffer FloatBuffer; +typedef Buffer< float > FloatBuffer; /** * The @c int buffer type * @since 2.0 */ -typedef Buffer IntBuffer; +typedef Buffer< int > IntBuffer; /** * The @c long buffer type * @since 2.0 */ -typedef Buffer LongBuffer; +typedef Buffer< long > LongBuffer; /** * The @c long @c long buffer type * @since 2.0 */ -typedef Buffer LongLongBuffer; +typedef Buffer< long long > LongLongBuffer; /** * The @c wchar_t buffer type * @since 2.0 */ -typedef Buffer WcharBuffer; +typedef Buffer< wchar_t > WcharBuffer; /** * The @c short buffer type * @since 2.0 */ -typedef Buffer ShortBuffer; +typedef Buffer< short > ShortBuffer; #ifdef _MSC_VER -template class _OSP_EXPORT_ Buffer ; -template class _OSP_EXPORT_ Buffer ; -template class _OSP_EXPORT_ Buffer ; -template class _OSP_EXPORT_ Buffer ; -template class _OSP_EXPORT_ Buffer ; -template class _OSP_EXPORT_ Buffer ; -template class _OSP_EXPORT_ Buffer ; +template class _OSP_EXPORT_ Buffer< double >; +template class _OSP_EXPORT_ Buffer< float >; +template class _OSP_EXPORT_ Buffer< int >; +template class _OSP_EXPORT_ Buffer< long >; +template class _OSP_EXPORT_ Buffer< long long >; +template class _OSP_EXPORT_ Buffer< wchar_t >; +template class _OSP_EXPORT_ Buffer< short >; #endif }} // Tizen::Base diff --git a/inc/FBaseBufferBase.h b/inc/FBaseBufferBase.h index 25f8d1a..6a07b8e 100644 --- a/inc/FBaseBufferBase.h +++ b/inc/FBaseBufferBase.h @@ -20,7 +20,6 @@ * * This header file contains the declarations of the %BufferBase class. */ - #ifndef _FBASE_BUFFER_BASE_H_ #define _FBASE_BUFFER_BASE_H_ @@ -89,7 +88,7 @@ public: * * @since 2.0 * - * @remarks After copying, the position is set to the number of elements copied rather than to @c 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. */ @@ -104,7 +103,7 @@ public: * * @param[in] to The value to set the buffer position @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 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. @@ -138,7 +137,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; @@ -161,7 +160,7 @@ public: * @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. - * @remarks Invoking this method neither changes nor discards the mark's value. + * @remarks Invoking this method neither changes nor discards the mark's value. */ result Reset(void); @@ -185,7 +184,7 @@ public: * @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. + * @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. * @see SetLimit() */ @@ -206,7 +205,7 @@ public: * * @since 2.0 * - * @return The limit of the calling object + * @return The limit of the calling object * @see SetLimit() */ int GetLimit(void) const; @@ -218,7 +217,7 @@ public: * * @since 2.0 * - * @return The mark of the calling %BufferBase instance + * @return The mark of the calling %BufferBase instance * @see SetMark() */ int GetMark(void) const; @@ -229,7 +228,7 @@ public: * * @since 2.0 * - * @return The current position of the calling %BufferBase instance + * @return The current position of the calling %BufferBase instance * @see SetPosition() */ int GetPosition(void) const; @@ -241,7 +240,7 @@ public: * * @since 2.0 * - * @return The number of elements between the current position and the limit + * @return The number of elements between the current position and the limit * @see HasRemaining() */ int GetRemaining(void) const; @@ -253,11 +252,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] limit The new limit + * @param[in] limit The new limit * @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 + * @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. + * @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. * @see GetLimit() */ @@ -281,11 +280,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] position The new position + * @param[in] position The new position * @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 + * @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. + * @remarks If the mark is defined and larger than the new position then it is discarded. * @see GetPosition() */ result SetPosition(int position); @@ -297,8 +296,8 @@ public: * @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 - * else @c false - * @see GetRemaining() + * else @c false + * @see GetRemaining() */ bool HasRemaining(void) const; @@ -309,9 +308,9 @@ public: * * @return An error code * @param[in] newCapacity The new capacity of this instance - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c capacity 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. + * @remarks After calling this method, the address of the internal buffer may be either the same or a new location. */ result ExpandCapacity(int newCapacity); @@ -330,10 +329,10 @@ protected: * @since 2.0 * * @return An error code - * @param[in] capacity The number of elements + * @param[in] capacity The number of elements * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. @n - * The @c capacity is negative. + * The @c capacity is negative. */ result Construct(int capacity); @@ -429,7 +428,7 @@ private: BufferBase& operator =(const BufferBase& rhs); friend class _BufferBaseImpl; - class _BufferBaseImpl * __pBufferBaseImpl; + class _BufferBaseImpl* __pBufferBaseImpl; }; // BufferBase diff --git a/inc/FBaseByteBuffer.h b/inc/FBaseByteBuffer.h index 9783a9f..ad5d64d 100644 --- a/inc/FBaseByteBuffer.h +++ b/inc/FBaseByteBuffer.h @@ -20,7 +20,6 @@ * * This header file contains the declarations of the %ByteBuffer class. */ - #ifndef _FBASE_BYTE_BUFFER_H_ #define _FBASE_BYTE_BUFFER_H_ @@ -75,7 +74,7 @@ namespace Tizen { namespace Base * * // Flips the buf * buf.Flip(); - * // Now, position = 0 and limit = 5 + * // Now, position = 0 and limit = 5 * * // Reads bytes from the buf using "relative access method" * while (buf.HasRemaining()) @@ -159,7 +158,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid, or * the source buffer is not constructed. - * @see ByteBuffer() + * @see ByteBuffer() */ result Construct(const ByteBuffer& buffer); @@ -173,7 +172,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid, or * the specified @c capacity is negative. - * @see ByteBuffer() + * @see ByteBuffer() */ result Construct(int capacity); @@ -182,18 +181,18 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] pBuffer The buffer which is shared - * @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] 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. + * @return An error code + * @param[in] pBuffer The buffer which is shared + * @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] 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. */ - result Construct(const byte *pBuffer, int index, int length, int capacity); + result Construct(const byte* pBuffer, int index, int length, int capacity); /** * Gets the reference to the byte value at the specified index. @@ -225,10 +224,10 @@ public: * @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 + * @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). - * @see Equals() + * @see Equals() */ bool operator ==(const ByteBuffer& buffer) const; @@ -240,20 +239,20 @@ public: * @return @c true if the two objects are not the same, @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 + * @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). - * @see Equals() + * @see Equals() */ bool operator !=(const ByteBuffer& buffer) const; /** * Creates a new @c double buffer view for the content of the byte buffer. - * + * * @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. + * @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. @@ -263,10 +262,10 @@ public: /** * Creates a new @c float buffer view for the content of the byte buffer. * - * @since 2.0 + * @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. + * @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. @@ -276,10 +275,10 @@ public: /** * Creates a new @c int buffer view for the content of the byte buffer. * - * @since 2.0 + * @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. + * @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. @@ -289,10 +288,10 @@ public: /** * Creates a new @c long buffer view for the content of the byte buffer. * - * @since 2.0 + * @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. + * @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. @@ -302,10 +301,10 @@ public: /** * Creates a new @c long @c long buffer view for the content of the byte buffer. * - * @since 2.0 + * @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. + * @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. @@ -319,10 +318,10 @@ public: * @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 + * @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. + * @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. @@ -336,7 +335,7 @@ public: * @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 + * @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 @@ -350,7 +349,7 @@ 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. + * @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. @@ -374,7 +373,7 @@ public: * @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 + * @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, @@ -417,7 +416,7 @@ public: * The following example has exactly the same effect as the above %CopyFrom() method. * * @code - * + * * int copyNum = srcBuf.GetRemaining(); * for (int i = 0; i < copyNum; i++) * { @@ -450,7 +449,7 @@ public: * 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, + * @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. * After the copy operation, the position is incremented by @c length bytes. * @see SetArray() @@ -464,7 +463,7 @@ public: * @since 2.0 * * @return An error code - * @param[out] value The @c byte value at the current position in the %ByteBuffer instance + * @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. @@ -480,7 +479,7 @@ public: * * @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[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. @@ -496,11 +495,11 @@ public: * @since 2.0 * * @return An error code - * @param[out] value The @c double value at the current position in the %ByteBuffer instance + * @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, + * @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. * @see SetDouble() */ @@ -518,7 +517,7 @@ public: * @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, + * @remarks This method reads size of @c double number of bytes at the given index, * composing them into a @c double value. * @see SetDouble() */ @@ -532,11 +531,11 @@ public: * @since 2.0 * * @return An error code - * @param[out] value The @c float value at the current position in the %ByteBuffer instance + * @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, + * @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. * @see SetFloat() */ @@ -549,12 +548,12 @@ public: * @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 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, + * @remarks This method reads the size of @c float number of bytes at the given index, * composing it into a @c float value. * @see SetFloat() */ @@ -568,11 +567,11 @@ public: * @since 2.0 * * @return An error code - * @param[out] value The @c int value at the current position in the %ByteBuffer instance + * @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, + * @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. * @see SetInt() */ @@ -585,12 +584,12 @@ public: * @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 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, + * @remarks This method reads the size of @c int number of bytes at the given index, * composing it into an @c int value. * @see SetInt() */ @@ -604,11 +603,11 @@ public: * @since 2.0 * * @return An error code - * @param[out] value The @c long value at the current position in the %ByteBuffer instance + * @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, + * @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. * @see SetLong() */ @@ -621,12 +620,12 @@ public: * @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 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, + * @remarks This method reads the size of @c long number of bytes at the given index, * composing it into a @c long value. * @see SetLong() */ @@ -640,14 +639,14 @@ public: * @since 2.0 * * @return An error code - * @param[out] value The @c long @c long value at the current position in the %ByteBuffer instance + * @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, + * @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. * @see SetLongLong() - */ + */ result GetLongLong(long long& value); /** @@ -657,12 +656,12 @@ public: * @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 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, + * @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. * @see SetLongLong() */ @@ -680,11 +679,11 @@ public: * @since 2.0 * * @return An error code - * @param[out] value The @c wchar_t value at the current position in the %ByteBuffer instance + * @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, + * @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. * @see SetMchar() * @endif @@ -698,13 +697,13 @@ public: * * @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. + * @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. * @see SetWchar() */ result GetWchar(wchar_t& value); @@ -725,7 +724,7 @@ public: * @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, + * @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. * @see SetMchar() * @endif @@ -739,13 +738,13 @@ public: * @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 - * @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. + * @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 + * @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. * @see SetWchar() */ result GetWchar(int index, wchar_t& value) const; @@ -758,11 +757,11 @@ public: * @since 2.0 * * @return An error code - * @param[out] value The @c short value at the current position in the %ByteBuffer instance + * @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, + * @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. * @see SetShort() */ @@ -775,12 +774,12 @@ public: * @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 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, + * @remarks This method reads the size of @c short number of bytes at the given index, * composing it into a @c short value. * @see SetShort() */ @@ -798,8 +797,8 @@ public: * 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 + * + * @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, @@ -882,7 +881,7 @@ public: * 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 + * @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. * After the copy operation, the position is incremented by @c length. @@ -898,7 +897,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] value The @c byte value to write to the current instance of %ByteBuffer + * @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. @@ -930,11 +929,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] value The @c double value to write + * @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 + * @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. * @see GetDouble() */ @@ -948,11 +947,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] value The @c float value to write + * @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 + * @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. * @see GetFloat() */ @@ -966,11 +965,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] value The @c int value to write + * @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 + * @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. * @see GetInt() */ @@ -984,11 +983,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] value The @c long value to write + * @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 + * @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. * @see GetLong() */ @@ -1002,11 +1001,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] value The @c long @c long value to write + * @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 + * @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. * @see GetLongLong() */ @@ -1024,11 +1023,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] value The @c wchar_t value to write + * @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 + * @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. * @see GetMchar() * @endif @@ -1043,12 +1042,12 @@ public: * @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. + * @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. * @see GetWchar() */ result SetWchar(wchar_t value); @@ -1061,11 +1060,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] value The @c short value to write + * @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 + * @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. * @see GetShort() */ @@ -1083,7 +1082,7 @@ public: * @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 + * @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. * @see GetDouble() */ @@ -1101,7 +1100,7 @@ public: * @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 + * @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. * @see GetFloat() */ @@ -1119,7 +1118,7 @@ public: * @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 + * @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. * @see GetInt() */ @@ -1137,7 +1136,7 @@ public: * @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 + * @remarks This method writes size of @c long number of bytes containing the given @c long value * into this buffer at the given index. * @see GetLong() */ @@ -1155,7 +1154,7 @@ public: * @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 + * @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. * @see GetLongLong() */ @@ -1177,7 +1176,7 @@ public: * @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 + * @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. * @see GetMchar() * @endif @@ -1191,13 +1190,13 @@ public: * @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 - * @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. + * @param[in] index The index at which the bytes will be 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. * @see GetWchar() */ result SetWchar(int index, wchar_t value); @@ -1214,7 +1213,7 @@ public: * @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 + * @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. * @see GetShort() */ @@ -1227,7 +1226,7 @@ public: * @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. + * @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, * and its mark is undefined. @@ -1262,7 +1261,7 @@ public: * @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 + * @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). * @see Tizen::Base::BufferBase::GetHashCode() @@ -1275,7 +1274,7 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @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. */ virtual int GetHashCode(void) const; @@ -1284,7 +1283,7 @@ private: * This copy constructor is intentionally declared as private to prohibit copying of objects by users. */ ByteBuffer(const ByteBuffer& buffer) - :__pByteBufferImpl(null) + : __pByteBufferImpl(null) { Construct(buffer); } @@ -1303,7 +1302,7 @@ private: friend class _ByteBufferImpl; - class _ByteBufferImpl * __pByteBufferImpl; + class _ByteBufferImpl* __pByteBufferImpl; }; // ByteBuffer diff --git a/inc/FBaseCharacter.h b/inc/FBaseCharacter.h index c4e8dd2..483894e 100644 --- a/inc/FBaseCharacter.h +++ b/inc/FBaseCharacter.h @@ -147,7 +147,7 @@ public: * @li == 0 if the value of the current instance is equal to the value of the input instance * @li > 0 if the value of the current instance is greater than the value of the input instance * @endcode - * + * */ int CompareTo(const Character& value) const; @@ -158,7 +158,7 @@ public: * @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 + * @param[in] obj The object to compare with the calling object * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Object& obj) const; @@ -331,7 +331,7 @@ public: * @since 2.0 * @if OSPCOMPAT * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCharacterIsAlphaNumericPage "here". + * For more information, see @ref CompCharacterIsAlphaNumericPage "here". * @endif * @return @c true if the input character is alphanumeric, @n * else @c false @@ -343,7 +343,7 @@ public: * @if OSPCOMPAT * @page CompCharacterIsAlphaNumericPage Compatibility for IsAlphaNumeric() * @section CompCharacterIsAlphaNumericPageIssueSection Issues - * Implementing this method in OSP compatible applications has the following issues: @n + * 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. * @@ -373,7 +373,7 @@ public: * @since 2.0 * @if OSPCOMPAT * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCharacterIsLetterPage "here". + * For more information, see @ref CompCharacterIsLetterPage "here". * @endif * @return @c true if the input character is an alphabet, @n * else @c false @@ -385,7 +385,7 @@ public: * @if OSPCOMPAT * @page CompCharacterIsLetterPage Compatibility for IsLetter() * @section CompCharacterIsLetterPageIssueSection Issues - * Implementing this method in OSP compatible applications has the following issues: @n + * 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. * @@ -453,7 +453,7 @@ public: /** * Returns the value of the input character in the supplied radix. @n - * The value of radix must be between RADIX_MIN and RADIX_MAX. + * The value of radix must be between RADIX_MIN and RADIX_MAX. * * @since 2.0 * @@ -465,7 +465,7 @@ public: /** * Returns the value which represents the input digit with specified radix. @n - * The value of radix must be between RADIX_MIN and RADIX_MAX. + * The value of radix must be between RADIX_MIN and RADIX_MAX. * * @since 2.0 * @@ -478,7 +478,7 @@ public: /** * 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 @c int value. * * @since 2.0 * @@ -493,7 +493,7 @@ public: * @since 2.0 * * @return @c true if the Unicode character is an assigned character, @n - * else @c false + * else @c false * @param[in] ch A Unicode character */ static bool IsDefined(wchar_t ch); @@ -505,7 +505,7 @@ public: * @since 2.0 * * @return @c true if the Unicode character is a whitespace character, @n - * else @c false + * else @c false * @param[in] ch A Unicode character * * @code @@ -530,7 +530,7 @@ public: * @since 2.0 * * @return @c true if the Unicode character is a title character, @n - * else @c false + * else @c false * @param[in] ch A Unicode character */ static bool IsTitleCase(wchar_t ch); @@ -551,7 +551,7 @@ public: * @since 2.0 * * @return @c true if the Unicode character is an ISO control character, @n - * else @c false + * else @c false * @param[in] ch A Unicode character */ static bool IsISOControl(wchar_t ch); @@ -630,7 +630,7 @@ private: wchar_t __val; friend class _CharacterImpl; - class _CharacterImpl * __pCharacterImpl; + class _CharacterImpl* __pCharacterImpl; }; // Character diff --git a/inc/FBaseCol.h b/inc/FBaseCol.h index 329f1ff..00bf0ac 100644 --- a/inc/FBaseCol.h +++ b/inc/FBaseCol.h @@ -21,7 +21,6 @@ * This header file contains the declarations and descriptions of the %Collection namespace. * */ - #ifndef _FBASE_COL_H_ #define _FBASE_COL_H_ @@ -64,9 +63,9 @@ * * The following diagrams illustrate the relationships between the classes belonging to the %Collection namespace. * - * @image html base_collection_namespace_obj_based_classdiagram.png + * @image html base_collection_namespace_obj_based_classdiagram.png * - * @image html base_collection_namespace_template_based_classdiagram.png + * @image html base_collection_namespace_template_based_classdiagram.png * * * diff --git a/inc/FBaseColAllElementsDeleter.h b/inc/FBaseColAllElementsDeleter.h index 2ec6360..9dfb600 100644 --- a/inc/FBaseColAllElementsDeleter.h +++ b/inc/FBaseColAllElementsDeleter.h @@ -20,7 +20,6 @@ * * This header file contains the declarations of the %AllElementsDeleter struct. */ - #ifndef _FBASE_COL_ALL_ELEMENTS_DELETER_H_ #define _FBASE_COL_ALL_ELEMENTS_DELETER_H_ @@ -42,8 +41,8 @@ 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. - * IList, IMap, and IMultiMap support this concept. + * @remarks The collection should be destructible and support the RemoveAll(bool) method. + * IList, IMap, and IMultiMap support this concept. */ template< typename Collection > void operator ()(Collection* c) diff --git a/inc/FBaseColArrayList.h b/inc/FBaseColArrayList.h index 541378e..a789693 100644 --- a/inc/FBaseColArrayList.h +++ b/inc/FBaseColArrayList.h @@ -139,7 +139,7 @@ public: * * @return An error code * @param[in] capacity The number of elements @n - * The default capacity is @c 10. + * 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. @@ -161,7 +161,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection A collection to add + * @param[in] collection A 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. @@ -176,7 +176,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj An pointer to object to add + * @param[in] pObj An pointer to 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. @@ -191,7 +191,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection A collection to add + * @param[in] collection A 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. @@ -217,12 +217,12 @@ public: * * @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) - * 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 + * @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) + * 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 */ virtual IBidirectionalEnumerator* GetBidirectionalEnumeratorN(void) const; @@ -233,7 +233,7 @@ public: * * @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 + * @param[in] index The index of the object in the calling list 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. @@ -273,7 +273,7 @@ public: * - 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. + * 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. */ @@ -307,8 +307,8 @@ public: * @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. + * 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. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int startIndex, int& index) const; @@ -329,8 +329,8 @@ public: * - 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. + * or less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int startIndex, int count, int& index) const; @@ -356,7 +356,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to insert + * @param[in] pObj The pointer to object to insert * @param[in] index The index at which the object must be inserted * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. @@ -399,7 +399,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj An object to remove + * @param[in] obj An object to remove * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. * @see Add() @@ -414,7 +414,7 @@ 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 must be 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. @@ -450,7 +450,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to remove from this list + * @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. @@ -473,8 +473,8 @@ 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 An pointer to object to set + * @param[in] index The index at which the object must be 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 @@ -491,8 +491,8 @@ public: * @return An error code * @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 The specified input parameter is invalid, or + * the @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() @@ -507,7 +507,7 @@ public: * @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 elements * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ @@ -557,14 +557,14 @@ public: * @since 2.0 * * @return @c true if the list contains all the elements of the specified @c collection, @n - * else @c false + * else @c false * @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. - * @see Contains() + * @see Contains() */ virtual bool ContainsAll(const ICollection& collection) const; @@ -633,8 +633,8 @@ private: * Sorts the specified sub-list. * * @return An error code - * @param[in] startIndex The starting point of the sub-list to sort - * @param[in] endIndex The end point of the sub-list to sort + * @param[in] startIndex The starting point of the sub-list to sort + * @param[in] endIndex The end point of the sub-list to sort * @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 elements. diff --git a/inc/FBaseColArrayListT.h b/inc/FBaseColArrayListT.h index 2bd1cf7..a687295 100644 --- a/inc/FBaseColArrayListT.h +++ b/inc/FBaseColArrayListT.h @@ -27,7 +27,6 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { @@ -140,7 +139,7 @@ public: * 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. + * 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. * Thus, if the size of the list can be estimated, @@ -165,7 +164,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection A collection of elements to add + * @param[in] collection A 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. @@ -191,7 +190,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj An object to add to the list + * @param[in] obj An object to add to the list * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @see Remove() @@ -217,7 +216,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] collection A collection of elements to add to the list + * @param[in] collection A 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. @@ -271,7 +270,7 @@ CATCH: * @return An instance of the IEnumeratorT derived class if successful, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @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 */ @@ -295,14 +294,14 @@ CATCH: * * @since 2.0 * - * @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). - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IBidirectionalEnumeratorT + * @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). + * @remarks The specific error code can be accessed using the GetLastResult() method. + * @see Tizen::Base::Collection::IBidirectionalEnumeratorT */ virtual IBidirectionalEnumeratorT< Type >* GetBidirectionalEnumeratorN(void) const { @@ -325,8 +324,8 @@ 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 An 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. @@ -348,8 +347,8 @@ 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 An 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. @@ -648,7 +647,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj The 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. * @see Add() @@ -675,7 +674,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] collection The collection to remove from this list + * @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. @@ -723,7 +722,7 @@ CATCH: * @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 that is 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. @@ -853,10 +852,10 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] newCapacity The new capacity to set for the list + * @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. + * the @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() @@ -911,7 +910,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] comparer A pointer to IComparerT + * @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. @@ -965,7 +964,7 @@ CATCH: * @since 2.0 * * @return The current capacity of the list - * @see SetCapacity() + * @see SetCapacity() */ int GetCapacity(void) const { @@ -1118,7 +1117,7 @@ CATCH: * * @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. + * the used hash function must generate a random distribution for all inputs. */ virtual int GetHashCode(void) const { @@ -1152,8 +1151,8 @@ private: * Sorts a section of a list using a comparer. * * @return An error code - * @param[in] startIndex The start index of the section of the list - * @param[in] endIndex The end index of the section of the list + * @param[in] startIndex The start index of the section of the list + * @param[in] endIndex The end index of the section of the list * @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 elements. @@ -1247,7 +1246,7 @@ public: { TryReturn((__modCount == __list.__modCount), E_INVALID_OPERATION, "[%s] The source collection is modified after the creation of this enumerator.", GetErrorMessage(E_INVALID_OPERATION)); - TryReturn((__position > -1) && (__position < static_cast (__list.__count)), E_INVALID_OPERATION, + TryReturn((__position > -1) && (__position < static_cast< int >(__list.__count)), E_INVALID_OPERATION, "[%s] Current position(%d) is before the first element or past the last element.", GetErrorMessage(E_INVALID_OPERATION), __position); obj = __list.__pObjArray[__position]; diff --git a/inc/FBaseColHashMapT.h b/inc/FBaseColHashMapT.h index e13765a..e731325 100644 --- a/inc/FBaseColHashMapT.h +++ b/inc/FBaseColHashMapT.h @@ -34,7 +34,6 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { @@ -150,8 +149,8 @@ public: * @since 2.0 * * @return An error code - * @param[in] capacity The initial capacity - * @param[in] loadFactor The maximum ratio of elements to buckets + * @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. @@ -345,7 +344,7 @@ CATCH: * @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. + * 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 @@ -486,7 +485,7 @@ CATCH: * * @return The value associated with the key, @n * else @c null if an exception occurs - * @param[in] key The key to locate + * @param[in] key The key to locate * @param[out] value The value associated with the key * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid, or @@ -527,7 +526,7 @@ CATCH: * * @return The value associated with the key, @n * else @c null if an exception occurs - * @param[in] key The key to locate + * @param[in] key The key to locate * @param[out] value The value associated with the key * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid, or @@ -755,8 +754,8 @@ 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 @c key, @n + * @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 @@ -907,7 +906,7 @@ private: * Copies all the pairs from a specified @c map to this map. * * @return An error code - * @param[in] map The map to copy + * @param[in] map The map to copy * @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 @c map is modified during the operation of this method. @@ -1159,7 +1158,7 @@ public: * @since 2.0 * * @return An error code - * @param[out] obj The current object + * @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 @@ -1239,7 +1238,7 @@ public: * @since 2.0 * * @return An error code - * @param[out] key The current key + * @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 diff --git a/inc/FBaseColIBidirectionalEnumerator.h b/inc/FBaseColIBidirectionalEnumerator.h index 205e05c..371ad85 100644 --- a/inc/FBaseColIBidirectionalEnumerator.h +++ b/inc/FBaseColIBidirectionalEnumerator.h @@ -31,8 +31,8 @@ namespace Tizen { namespace Base { namespace Collection { /** - * @interface IBidirectionalEnumerator - * @brief This interface supports a bidirectional iteration over a collection. + * @interface IBidirectionalEnumerator + * @brief This interface supports a bidirectional iteration over a collection. * * @since 2.0 * @@ -66,7 +66,7 @@ public: * @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. + * the collection is modified after the enumerator is created. * @see Tizen::Base::Collection::IEnumerator::MoveNext() * @see ResetLast() */ diff --git a/inc/FBaseColIBidirectionalEnumeratorT.h b/inc/FBaseColIBidirectionalEnumeratorT.h index efbd87b..d12fe54 100644 --- a/inc/FBaseColIBidirectionalEnumeratorT.h +++ b/inc/FBaseColIBidirectionalEnumeratorT.h @@ -31,8 +31,8 @@ namespace Tizen { namespace Base { namespace Collection { /** - * @interface IBidirectionalEnumeratorT - * @brief This interface supports a bidirectional iteration over a collection. + * @interface IBidirectionalEnumeratorT + * @brief This interface supports a bidirectional iteration over a collection. * * @since 2.0 * diff --git a/inc/FBaseColICollection.h b/inc/FBaseColICollection.h index 2bf253c..e3cac90 100644 --- a/inc/FBaseColICollection.h +++ b/inc/FBaseColICollection.h @@ -32,7 +32,6 @@ #include #include - #ifdef ICollection #undef ICollection #endif @@ -41,9 +40,9 @@ 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. + * @interface ICollection + * @brief This interface represents a collection of objects. @n + * It defines the size, enumerators, and the synchronization mechanism of a collection. * * @since 2.0 * diff --git a/inc/FBaseColICollectionT.h b/inc/FBaseColICollectionT.h index 1021fad..859d4bd 100644 --- a/inc/FBaseColICollectionT.h +++ b/inc/FBaseColICollectionT.h @@ -33,14 +33,14 @@ namespace Tizen { namespace Base { namespace Collection { /** - * @interface ICollectionT - * @brief This interface represents a template-based collection of objects. - * It defines the size, and enumerators. + * @interface ICollectionT + * @brief This interface represents a template-based collection of objects. + * It defines the size, and 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 enumerators. */ template< class Type > class ICollectionT @@ -72,7 +72,7 @@ public: * @return A pointer to an 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. + * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks Use this method to obtain an 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. diff --git a/inc/FBaseColIComparer.h b/inc/FBaseColIComparer.h index 21a82c9..689b1f2 100644 --- a/inc/FBaseColIComparer.h +++ b/inc/FBaseColIComparer.h @@ -26,12 +26,11 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { /** - * @interface IComparer - * @brief This interface allows a derived class to compare 2 objects of the same type. + * @interface IComparer + * @brief This interface allows a derived class to compare 2 objects of the same type. * * @since 2.0 * diff --git a/inc/FBaseColIComparerT.h b/inc/FBaseColIComparerT.h index ae711e6..f1c6f42 100644 --- a/inc/FBaseColIComparerT.h +++ b/inc/FBaseColIComparerT.h @@ -25,7 +25,6 @@ #include - namespace Tizen { namespace Base { namespace Collection { /** diff --git a/inc/FBaseColIHashCodeProvider.h b/inc/FBaseColIHashCodeProvider.h index dd46fcc..9ccd9d1 100644 --- a/inc/FBaseColIHashCodeProvider.h +++ b/inc/FBaseColIHashCodeProvider.h @@ -33,7 +33,7 @@ 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 can provide the hash code of a specific type of object. * * @since 2.0 * @@ -73,7 +73,6 @@ protected: // virtual void IHashCodeProvider_Reserved1(void) { } - // // This method is for internal use only. Using this method can cause behavioral, security-related, // and consistency-related issues in the application. diff --git a/inc/FBaseColIList.h b/inc/FBaseColIList.h index 3736489..21811c1 100644 --- a/inc/FBaseColIList.h +++ b/inc/FBaseColIList.h @@ -33,8 +33,8 @@ namespace Tizen { namespace Base { namespace Collection { /** - * @interface IList - * @brief This interface represents a collection of objects that can be individually accessed by an index. + * @interface IList + * @brief This interface represents a collection of objects that can be individually accessed by an index. * * @since 2.0 * @@ -63,7 +63,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj The 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. * @remarks In a collection of contiguous elements, such as a list, the elements @@ -86,8 +86,8 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to add - * @exception E_SUCCESS The method is successful. + * @param[in] pObj The pointer to 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. @@ -105,7 +105,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to add to the list + * @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. @@ -145,7 +145,7 @@ public: * 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 * 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 the pointer only; not the element itself. * @see Add(Object*) * @see RemoveAt() * @endif @@ -161,7 +161,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to insert + * @param[in] pObj The pointer to object to insert * @param[in] index The index at which the object must be inserted * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. @@ -275,7 +275,7 @@ public: * * @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 + * @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. @@ -300,7 +300,7 @@ public: * - 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. + * The specific error code can be accessed using the GetLastResult() method. */ virtual IList* GetItemsN(int startIndex, int count) const = 0; @@ -360,7 +360,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj The 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. * @see Add(Object*) @@ -374,7 +374,7 @@ 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 must be removed * @param[in] forceDeletion Set to @c true to deallocate the object, @n * else @c false * @exception E_SUCCESS The method is successful. @@ -423,7 +423,7 @@ 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 must be 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. @@ -577,7 +577,7 @@ public: * * @return An error code * @param[in] forceDeletion Set to @c true to deallocate all the objects, @n - * else @c false + * 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 @@ -695,7 +695,7 @@ public: * @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 elements * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ @@ -747,7 +747,7 @@ public: * * @return @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[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. @@ -763,12 +763,12 @@ public: * * @since 2.0 * - * @return A pointer to a 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) - * 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 + * @return A pointer to a 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) + * 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 */ virtual IBidirectionalEnumerator* GetBidirectionalEnumeratorN(void) const = 0; diff --git a/inc/FBaseColIListT.h b/inc/FBaseColIListT.h index b665d6f..b0109fd 100644 --- a/inc/FBaseColIListT.h +++ b/inc/FBaseColIListT.h @@ -27,13 +27,12 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { /** - * @interface IListT - * @brief This interface represents a template-based collection of objects that can be individually accessed by an index. + * @interface IListT + * @brief This interface represents a template-based collection of objects that can be individually accessed by an index. * * @since 2.0 * @@ -59,7 +58,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj The 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. * @remarks In a collection of contiguous elements, such as a list, the elements @@ -77,7 +76,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The 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. @@ -200,7 +199,7 @@ public: * * @return An error code * @param[in] index The index of the object to get - * @param[out] obj The object obtained from the list + * @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. @@ -215,7 +214,7 @@ public: * * @return An error code * @param[in] index The index of the object to get - * @param[out] obj The object obtained from the list + * @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. @@ -248,7 +247,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj The object to remove + * @param[in] obj The object to remove * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The object is not found. */ @@ -260,7 +259,7 @@ 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 must be 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. @@ -273,7 +272,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to remove from this list + * @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. @@ -314,7 +313,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj The new object + * @param[in] obj The new object * @param[in] index The index at which the new object must be 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 @@ -329,8 +328,8 @@ public: * @since 2.0 * * @return An error code - * @param[in] comparer The IComparerT implementation to use when comparing elements - * @exception E_SUCCESS The method is successful. + * @param[in] comparer The IComparerT implementation to use when comparing elements + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ virtual result Sort(const IComparerT< Type >& comparer) = 0; @@ -368,14 +367,14 @@ public: * * @since 2.0 * - * @return A pointer to a 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 + * @return A pointer to a 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 */ virtual IBidirectionalEnumeratorT< Type >* GetBidirectionalEnumeratorN(void) const = 0; diff --git a/inc/FBaseColIMap.h b/inc/FBaseColIMap.h index 4faa057..01faca3 100644 --- a/inc/FBaseColIMap.h +++ b/inc/FBaseColIMap.h @@ -28,7 +28,6 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { @@ -36,8 +35,8 @@ class IList; class MapEntry; /** - * @interface IMap - * @brief This interface represents a collection of key-value pairs. + * @interface IMap + * @brief This interface represents a collection of key-value pairs. * * @since 2.0 * @@ -135,7 +134,7 @@ public: * * @return The value associated with 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 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. @@ -152,7 +151,7 @@ public: * * @return The value associated with 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 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. @@ -199,7 +198,7 @@ public: * @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 + * 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. @@ -248,7 +247,7 @@ public: * @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 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. @@ -264,7 +263,7 @@ public: * @since 2.0 * * @param[in] forceDeletion Set to @c true to deallocate all the objects, @n - * else @c false + * 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 @@ -314,10 +313,10 @@ public: * @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 to replace + * @param[in] value The new value * @param[in] forceDeletion Set to @c true to deallocate the object, @n - * else @c false + * 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. @@ -367,14 +366,14 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key for which the value is to replace + * @param[in] key The key for which the value is to replace * @param[in] pValue The pointer to 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. - * @remarks Use the Add(Object*, Object*) method to add a new key-value pair. - * @see GetValue() + * @remarks Use the Add(Object*, Object*) method to add a new key-value pair. + * @see GetValue() */ virtual result SetValue(const Object& key, Object* pValue) = 0; @@ -412,7 +411,7 @@ public: * * @return @c true if the map contains the specified 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 A specified input parameter is invalid, or * the comparer has failed to compare the keys. @@ -439,7 +438,7 @@ public: * * @since 2.0 * - * @return IMapEnumerator object of this map, @n + * @return IMapEnumerator object of 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. @@ -467,7 +466,6 @@ protected: // virtual void IMap_Reserved1(void) { } - // // This method is for internal use only. Using this method can cause behavioral, security-related, // and consistency-related issues in the application. diff --git a/inc/FBaseColIMapEnumerator.h b/inc/FBaseColIMapEnumerator.h index f656fb9..ef95d93 100644 --- a/inc/FBaseColIMapEnumerator.h +++ b/inc/FBaseColIMapEnumerator.h @@ -26,15 +26,14 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { class MapEntry; /** - * @interface IMapEnumerator - * @brief This interface supports simple iteration over a map. + * @interface IMapEnumerator + * @brief This interface supports simple iteration over a map. * * @since 2.0 * @@ -69,7 +68,7 @@ public: * @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 + * @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 * - The collection is modified after the enumerator is created. @@ -85,7 +84,7 @@ 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 + * @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 * - The collection is modified after the enumerator is created. @@ -101,7 +100,7 @@ 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 + * @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 * - The collection is modified after the enumerator is created. diff --git a/inc/FBaseColIMapEnumeratorT.h b/inc/FBaseColIMapEnumeratorT.h index f10f34e..c072465 100644 --- a/inc/FBaseColIMapEnumeratorT.h +++ b/inc/FBaseColIMapEnumeratorT.h @@ -26,14 +26,13 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { /** - * @interface IMapEnumeratorT - * @brief This interface supports 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. + * @interface IMapEnumeratorT + * @brief This interface supports 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 * @@ -43,7 +42,7 @@ namespace Tizen { namespace Base { namespace Collection * deleting elements, the enumerator is irrecoverably invalidated. The next call to any method returns an @c E_INVALID_OPERATION message. * * The %IMapEnumeratorT interface supports simple iteration over a template-based map. - * Using this method, you can only access the elements in the map. You cannot modify the elements. + * 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,7 +66,7 @@ public: * @since 2.0 * * @return An error code - * @param[out] key The current key + * @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_SUCCESS The method is successful. @@ -80,7 +79,7 @@ public: * @since 2.0 * * @return An error code - * @param[out] value The current value + * @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_SUCCESS The method is successful. diff --git a/inc/FBaseColIMapT.h b/inc/FBaseColIMapT.h index 5359f8d..7d8ca4d 100644 --- a/inc/FBaseColIMapT.h +++ b/inc/FBaseColIMapT.h @@ -27,15 +27,14 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { template< class Type > class IListT; /** - * @interface IMapT - * @brief This interface abstracts a template-based collection of key-value pairs. + * @interface IMapT + * @brief This interface abstracts a template-based collection of key-value pairs. * * @since 2.0 * @@ -69,7 +68,7 @@ public: * @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. + * the comparer has failed to compare the keys. * @exception E_OBJ_ALREADY_EXIST The specified @c key already exists. * @see Remove() */ @@ -143,7 +142,7 @@ public: * @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 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. @@ -186,7 +185,7 @@ public: * @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 + * @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. diff --git a/inc/FBaseColIMultiMap.h b/inc/FBaseColIMultiMap.h index f3b7d61..dd5b9e7 100644 --- a/inc/FBaseColIMultiMap.h +++ b/inc/FBaseColIMultiMap.h @@ -28,7 +28,6 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { @@ -178,7 +177,7 @@ public: * @return An error code * @param[in] key The key for which the associated values need to remove * @param[in] forceDeletion Set to @c true to deallocate the object, @n - * else @c false + * 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. @@ -227,7 +226,7 @@ public: * @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 need 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. @@ -246,7 +245,7 @@ public: * @param[in] key The key for which the mapping is to remove 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 + * 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. @@ -313,7 +312,7 @@ public: * @since 2.0 * * @param[in] forceDeletion Set to @c true to deallocate all objects, @n - * else @c false + * 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 @@ -368,7 +367,7 @@ public: * @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 + * 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. @@ -418,8 +417,8 @@ public: * @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] 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 * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid, or @@ -512,7 +511,7 @@ public: * * @return @c true if the map contains the specified 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 A specified input parameter is invalid, or * the comparer has failed to compare the keys. @@ -572,7 +571,6 @@ protected: // virtual void IMultiMap_Reserved1(void) { } - // // This method is for internal use only. Using this method can cause behavioral, security-related, // and consistency-related issues in the application. diff --git a/inc/FBaseColIMultiMapT.h b/inc/FBaseColIMultiMapT.h index 38c3b85..1c2a8a4 100644 --- a/inc/FBaseColIMultiMapT.h +++ b/inc/FBaseColIMultiMapT.h @@ -27,15 +27,14 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { template< class Type > class IListT; /** - * @interface IMultiMapT - * @brief This interface represents a template-based collection of key-value pairs. + * @interface IMultiMapT + * @brief This interface represents a template-based collection of key-value pairs. * * @since 2.0 * @@ -91,7 +90,7 @@ public: * @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[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 @@ -107,7 +106,7 @@ public: * * @return An instance of the IEnumeratorT derived class with the values associated with the specified 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. @@ -152,7 +151,7 @@ public: * @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 need 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. @@ -168,7 +167,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key whose mapping is to remove from the map + * @param[in] key The key whose mapping is to remove 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 diff --git a/inc/FBaseColIteratorT.h b/inc/FBaseColIteratorT.h index 7e38af6..67ad607 100644 --- a/inc/FBaseColIteratorT.h +++ b/inc/FBaseColIteratorT.h @@ -24,7 +24,7 @@ #ifndef _FBASE_COL_ITERATOR_T_H_ #define _FBASE_COL_ITERATOR_T_H_ -#include // std::swap (Before C++11) +#include // std::swap (Before C++11) #include #include #include @@ -47,7 +47,7 @@ namespace Tizen { namespace Base { namespace Collection * StlConverter provides static methods to get this iterator from IList. */ -template < typename T > +template< typename T > class IteratorT : public std::iterator< std::input_iterator_tag, T > { @@ -122,7 +122,7 @@ public: * @return A reference to the %IteratorT instance * @param[in] rhs A reference to the %IteratorT instance on the right-hand side of the operator */ - IteratorT< T >& operator=(const IteratorT< T >& rhs) + IteratorT< T >& operator =(const IteratorT< T >& rhs) { IteratorT< T > tmp(rhs); tmp.swap(*this); @@ -136,7 +136,7 @@ public: * * @return A T type reference */ - T& operator*(void) const + T& operator *(void) const { AppAssertf(!__isPostEnd && __index >= 0, "It is out of range."); return const_cast< T& >(__currentObj); @@ -149,9 +149,9 @@ public: * * @return A T type pointer that is equivalent to the pointer address */ - T* operator->(void) const + T* operator ->(void) const { - return &(operator*()); + return &(operator *()); } /** @@ -166,7 +166,7 @@ public: * the collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ - IteratorT< T >& operator++(void) + IteratorT< T >& operator ++(void) { const int PRE_BEGIN_IDX = -1; TryCatchResult(__index >= PRE_BEGIN_IDX, , E_OUT_OF_RANGE, "[%s] It is out of range.", GetErrorMessage(E_OUT_OF_RANGE)); @@ -174,12 +174,13 @@ public: if (__index != PRE_BEGIN_IDX) { result r = __pEnum->MoveNext(); - TryCatchResult(r == E_SUCCESS, __isPostEnd = true; __currentObj = null, r, "[%s] It already reached the end.", GetErrorMessage(r)); + TryCatchResult(r == E_SUCCESS, __isPostEnd = true; + __currentObj = null, r, "[%s] It already reached the end.", GetErrorMessage(r)); } __currentObj = static_cast< T >(__pEnum->GetCurrent()); - CATCH: +CATCH: ++__index; return *this; } @@ -196,10 +197,10 @@ public: * the collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ - IteratorT< T > operator++(int) + IteratorT< T > operator ++(int) { IteratorT< T > tempIter = *this; - operator++(); + operator ++(); return tempIter; } @@ -215,7 +216,7 @@ public: * the collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ - IteratorT< T >& operator--(void) + IteratorT< T >& operator --(void) { TryCatchResult(__index <= __pList->GetCount(), , E_OUT_OF_RANGE, "[%s] It is out of range.", GetErrorMessage(E_OUT_OF_RANGE)); @@ -248,10 +249,10 @@ CATCH: * the collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ - IteratorT< T > operator--(int) + IteratorT< T > operator --(int) { IteratorT< T > tempIter = *this; - operator--(); + operator --(); return tempIter; } @@ -264,7 +265,7 @@ CATCH: * else @c false * @param[in] rhs A reference to the %IteratorT instance on the right-hand side of the operator */ - bool operator==(const IteratorT< T >& rhs) const + bool operator ==(const IteratorT< T >& rhs) const { if (__pList != rhs.__pList) { @@ -299,9 +300,9 @@ CATCH: * else @c false * @param[in] rhs A reference to the %IteratorT instance on the right-hand side of the operator */ - bool operator!=(const IteratorT< T >& rhs) const + bool operator !=(const IteratorT< T >& rhs) const { - return !operator==(rhs); + return !operator ==(rhs); } /** diff --git a/inc/FBaseColLinkedList.h b/inc/FBaseColLinkedList.h index 6859bad..32afbd5 100644 --- a/inc/FBaseColLinkedList.h +++ b/inc/FBaseColLinkedList.h @@ -26,7 +26,6 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { @@ -131,9 +130,9 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj An pointer to object to add + * @param[in] pObj An pointer to object to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @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. * @see Remove() */ @@ -145,7 +144,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection A collection to add + * @param[in] collection A 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. @@ -171,12 +170,12 @@ public: * * @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) - * 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 + * @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) + * 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 */ virtual IBidirectionalEnumerator* GetBidirectionalEnumeratorN(void) const; @@ -187,7 +186,7 @@ public: * * @return A pointer to the object at the specified index of the list, @n * else @c null if the index is not valid - * @param[in] index The index of the object to read + * @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. @@ -203,7 +202,7 @@ public: * * @return A pointer to the object at the specified index of the list, @n * else @c null if the index is not valid - * @param[in] index The index of the object to read + * @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. @@ -307,7 +306,7 @@ public: * * @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] index The index at which the object must be 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 @@ -335,7 +334,7 @@ public: * 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. + * This method performs a shallow copy. It inserts just the pointer; not the element itself. * @see RemoveItems() * @see AddItems() */ @@ -347,7 +346,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj An object to remove + * @param[in] obj An object to remove * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. * @see Add() @@ -361,7 +360,7 @@ 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 must be 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. @@ -394,7 +393,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to remove from this list + * @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. @@ -420,7 +419,7 @@ public: * * @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] index The index at which the object must be 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 @@ -435,7 +434,7 @@ public: * @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 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. @@ -469,8 +468,8 @@ public: * @since 2.0 * * @return @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 + * 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. @@ -533,7 +532,7 @@ private: * Allocates and adds a memory block. * * @return An error code - * @param[in] blockSize The size of block to allocate + * @param[in] blockSize The size of block to allocate * @exception E_SUCCESS The method is successful. */ result AddBlock(int blockSize = DEFAULT_CAPACITY); @@ -548,7 +547,7 @@ private: * Inserts an object to the beginning of the %LinkedList. * * @return An error code - * @param[in] pObj The pointer to object to insert + * @param[in] pObj The pointer to object to insert * @exception E_SUCCESS The method is successful. */ result InsertFirst(Object* pObj); @@ -557,7 +556,7 @@ private: * Inserts an object to the end of the %LinkedList. * * @return An error code - * @param[in] pObj The pointer to object to insert + * @param[in] pObj The pointer to object to insert * @exception E_SUCCESS The method is successful. */ result InsertLast(Object* pObj); @@ -566,8 +565,8 @@ private: * Inserts an object after the specified node. * * @return An error code - * @param[in] pObj The pointer to object to insert - * @param[in] pPrevNode The node after which the object must inserted + * @param[in] pObj The pointer to object to insert + * @param[in] pPrevNode The node after which the object must inserted * @exception E_SUCCESS The method is successful. */ result InsertNext(Object* pObj, _ListNode* pPrevNode); diff --git a/inc/FBaseColLinkedListT.h b/inc/FBaseColLinkedListT.h index 1485a08..01c1b71 100644 --- a/inc/FBaseColLinkedListT.h +++ b/inc/FBaseColLinkedListT.h @@ -27,7 +27,6 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { @@ -131,7 +130,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj An object to add + * @param[in] obj An object to add * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @see Remove() @@ -162,7 +161,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection A collection to add + * @param[in] collection A 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. @@ -212,14 +211,14 @@ CATCH: * * @since 2.0 * - * @return An instance of the IBidirectionalEnumeratorT derived class if successful, @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 + * @return An instance of the IBidirectionalEnumeratorT derived class if successful, @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 */ virtual IBidirectionalEnumeratorT< Type >* GetBidirectionalEnumeratorN(void) const { @@ -243,8 +242,8 @@ 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 An 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. @@ -270,8 +269,8 @@ 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 An 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. @@ -465,7 +464,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj An object to insert + * @param[in] obj An object to insert * @param[in] index The index at which the object must be 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 @@ -636,7 +635,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj An object to remove + * @param[in] obj An object to remove * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. * @see Add() @@ -667,7 +666,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] collection The collection to remove from this list + * @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. @@ -721,7 +720,7 @@ 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 must be 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. @@ -746,7 +745,7 @@ CATCH: * @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 + * @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. @@ -756,13 +755,13 @@ CATCH: virtual result RemoveItems(int startIndex, int count) { TryReturn(startIndex >= 0 && count >= 0, E_OUT_OF_RANGE, - "[%s] Both of the startIndex(%d) and count(%d) MUST be greater than or equal to 0.", - GetErrorMessage(E_OUT_OF_RANGE), startIndex, count); + "[%s] Both of the startIndex(%d) and count(%d) MUST be greater than or equal to 0.", + GetErrorMessage(E_OUT_OF_RANGE), startIndex, count); TryReturn(startIndex < __count, E_OUT_OF_RANGE, - "[%s] The startIndex(%d) MUST be less than the number of elements(%d).", GetErrorMessage(E_OUT_OF_RANGE), startIndex, __count); + "[%s] The startIndex(%d) MUST be less than the number of elements(%d).", GetErrorMessage(E_OUT_OF_RANGE), startIndex, __count); TryReturn(count <= __count && (startIndex + count <= __count), E_OUT_OF_RANGE, - "[%s] The startIndex(%d) + count(%d) MUST be less than or equal to the number of elements(%d).", - GetErrorMessage(E_OUT_OF_RANGE), startIndex, count, __count); + "[%s] The startIndex(%d) + count(%d) MUST be less than or equal to the number of elements(%d).", + GetErrorMessage(E_OUT_OF_RANGE), startIndex, count, __count); if (count > 0) { @@ -810,7 +809,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj An object to set + * @param[in] obj An 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 index is outside the bounds of the data structure, or @@ -839,7 +838,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] comparer The IComparerT implementation to use when comparing the elements + * @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. @@ -1087,7 +1086,7 @@ private: * Inserts an object to the beginning of the %LinkedList. * * @return An error code - * @param[in] obj The object to insert + * @param[in] obj The object to insert * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SUCCESS The method is successful. */ @@ -1121,7 +1120,7 @@ CATCH: * Inserts an object to the end of the LinkedList. * * @return An error code - * @param[in] obj The object to insert + * @param[in] obj The object to insert * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SUCCESS The method is successful. */ @@ -1140,8 +1139,8 @@ CATCH: * Inserts an object after the specified node. * * @return An error code - * @param[in] obj The object to insert - * @param[in] pPrevNode The node after which the object must be inserted + * @param[in] obj The object to insert + * @param[in] pPrevNode The node after which the object must be inserted * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SUCCESS The method is successful. * @remarks The specific error code can be accessed using the GetLastResult() method. diff --git a/inc/FBaseColMapEntry.h b/inc/FBaseColMapEntry.h index 8b5a91d..0b29a20 100644 --- a/inc/FBaseColMapEntry.h +++ b/inc/FBaseColMapEntry.h @@ -25,7 +25,6 @@ #include - namespace Tizen { namespace Base { namespace Collection { diff --git a/inc/FBaseColMapEntryT.h b/inc/FBaseColMapEntryT.h index ad2aa83..5eb2b3e 100644 --- a/inc/FBaseColMapEntryT.h +++ b/inc/FBaseColMapEntryT.h @@ -25,12 +25,11 @@ #include - namespace Tizen { namespace Base { namespace Collection { /** - * @class MapEntryT + * @class MapEntryT * @brief This class represents a template-based key-value pair. * * @since 2.0 @@ -61,7 +60,7 @@ public: * * @since 2.0 * - * @param[in] key The key for this mapping + * @param[in] key The key for this mapping * @param[in] value The value for this mapping */ MapEntryT(const KeyType& key, const ValueType& value) @@ -105,7 +104,7 @@ public: * @since 2.0 * * @return The key corresponding to this entry - * @see GetValue() + * @see GetValue() */ virtual const KeyType& GetKey(void) const { diff --git a/inc/FBaseColMultiHashMap.h b/inc/FBaseColMultiHashMap.h index 6733d3a..25ac0d2 100644 --- a/inc/FBaseColMultiHashMap.h +++ b/inc/FBaseColMultiHashMap.h @@ -28,7 +28,6 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { @@ -142,7 +141,7 @@ public: * @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. + * the @c capacity or the @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() @@ -183,7 +182,7 @@ public: * @param[in] comparer An instance of the IComparer derived class to use when comparing 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. + * 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. * @see MultiHashMap() */ @@ -263,7 +262,7 @@ public: * * @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 + * @param[in] key A 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. @@ -280,7 +279,7 @@ public: * * @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. + * The specific error code can be accessed using the GetLastResult() method. * @see GetValuesN() */ virtual IList* GetKeysN(void) const; @@ -292,7 +291,7 @@ public: * * @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. + * The specific error code can be accessed using the GetLastResult() method. * @see GetKeysN() */ virtual IList* GetValuesN(void) const; @@ -303,7 +302,7 @@ public: * @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 A specified input parameter is invalid, or * the comparer has failed to compare keys. @@ -318,7 +317,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key whose mapping is to remove from the map + * @param[in] key The key whose mapping is to remove 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 @@ -344,8 +343,8 @@ public: * @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] 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 * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid, or @@ -388,8 +387,8 @@ public: * * @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. @@ -406,7 +405,7 @@ public: * * @return @c true if the map contains the specified 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 A specified input parameter is invalid, or * the comparer has failed to compare the keys. @@ -482,7 +481,7 @@ private: * Copies all the pairs from the specified map to this map. * * @return An error code - * @param[in] map The map to copy + * @param[in] map The map to copy * @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 @c map is modified during the operation of this method. @@ -505,7 +504,7 @@ private: * @return An error code * @param[in] newCapacity The new capacity @n * It must be a power of two and be greater than current capacity. - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. */ result Resize(int newCapacity); diff --git a/inc/FBaseColMultiHashMapT.h b/inc/FBaseColMultiHashMapT.h index cb2e36e..037a2bb 100644 --- a/inc/FBaseColMultiHashMapT.h +++ b/inc/FBaseColMultiHashMapT.h @@ -33,7 +33,6 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { @@ -165,7 +164,7 @@ public: * @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. + * the specified @c capacity or the @c loadFactor is negative. * @remarks The key type must be a primitive data type. * @see MultiHashMapT() */ @@ -293,10 +292,10 @@ CATCH: * 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] comparer An instance of the IComparer derived class to use when comparing 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. + * 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. * @see MultiHashMapT() */ @@ -552,7 +551,7 @@ CATCH: * * @return An 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 A 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. @@ -687,7 +686,7 @@ CATCH: * @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. @@ -749,7 +748,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] key The key whose mapping is to remove from the map + * @param[in] key The key whose mapping is to remove 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 @@ -848,10 +847,10 @@ CATCH: * @param[in] key A key * @param[in] value A value to replace * @param[in] newValue A new value to replace the existing value - * @exception E_SUCCESS The method is successful. + * @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_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() @@ -926,9 +925,9 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] key A key to locate + * @param[in] key A key to locate * @param[out] count The number of values whose key is @c key - * @exception E_SUCCESS The method is successful. + * @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. @@ -972,8 +971,8 @@ CATCH: * @since 2.0 * * @return An error code - * @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 * @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. @@ -1028,7 +1027,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] key The key to locate + * @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. @@ -1205,7 +1204,7 @@ private: * Copies all the pairs from the specified map to this map. * * @return An error code - * @param[in] map The map to copy + * @param[in] map The map to copy * @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 @c map is modified during the operation of this method. @@ -1425,10 +1424,10 @@ 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 - * 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] list A 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 */ __MultiHashMapEntryT(const KeyType& keyType, __ValueNodeT< ValueType >* list, __MultiHashMapEntryT< KeyType, ValueType >* next, int h) : key(keyType) @@ -1530,13 +1529,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 - * - This enumerator is currently positioned before the first element or - * past the last element. @n - * - The map is modified after this enumerator is created. - * @exception E_SUCCESS The method is successful. + * @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 + * - This enumerator is currently positioned before the first element or + * past the last element. @n + * - The map is modified after this enumerator is created. + * @exception E_SUCCESS The method is successful. */ result GetCurrent(MapEntryT< KeyType, ValueType >& obj) const { @@ -1627,13 +1626,13 @@ public: * @since 2.0 * * @return An error code - * @param[out] key The current key - * @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 - * - This enumerator is currently positioned before the first element or - * past the last element. @n - * - The map is modified after this enumerator is created. - * @exception E_SUCCESS The method is successful. + * @param[out] key The current key + * @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 + * - This enumerator is currently positioned before the first element or + * 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,13 +1651,13 @@ public: * @since 2.0 * * @return An error code - * @param[out] value The current value - * @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 - * - This enumerator is currently positioned before the first element or - * past the last element. @n - * - The map is modified after the enumerator is created. - * @exception E_SUCCESS The method is successful. + * @param[out] value The current value + * @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 + * - This enumerator is currently positioned before the first element or + * past the last element. @n + * - The map is modified after the enumerator is created. + * @exception E_SUCCESS The method is successful. */ result GetValue(ValueType& value) const { @@ -1722,7 +1721,7 @@ public: * @since 2.0 * * @return An error code - * @param[out] obj The current value + * @param[out] obj The current value * @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 * - This enumerator is currently positioned before the first element or diff --git a/inc/FBaseColPairIteratorT.h b/inc/FBaseColPairIteratorT.h index 3d71646..037fa3e 100644 --- a/inc/FBaseColPairIteratorT.h +++ b/inc/FBaseColPairIteratorT.h @@ -24,7 +24,7 @@ #ifndef _FBASE_COL_PAIR_ITERATOR_T_H_ #define _FBASE_COL_PAIR_ITERATOR_T_H_ -#include // std::swap (Before C++11) +#include // std::swap (Before C++11) #include #include #include @@ -49,7 +49,7 @@ namespace Tizen { namespace Base { namespace Collection * StlConverter provides static methods to get this iterator from IMap or IMultiMap. */ -template < typename K, typename V > +template< typename K, typename V > class PairIteratorT : public std::iterator< std::input_iterator_tag, std::pair< K, V > > { @@ -178,7 +178,7 @@ public: * 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) + PairIteratorT< K, V >& operator =(const PairIteratorT< K, V >& rhs) { PairIteratorT< K, V > tmp(rhs); tmp.swap(*this); @@ -192,7 +192,7 @@ public: * * @return A std::pair type reference with K and V type */ - std::pair< K, V >& operator*(void) const + std::pair< K, V >& operator *(void) const { AppAssertf(!__isPostEnd, "It is out of range."); return const_cast< std::pair< K, V >& >(__currentObj); @@ -205,9 +205,9 @@ public: * * @return A std::pair type pointer equivalent to the pointer address */ - std::pair< K, V >* operator->(void) const + std::pair< K, V >* operator ->(void) const { - return &(operator*()); + return &(operator *()); } /** @@ -222,12 +222,14 @@ public: * 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) + PairIteratorT< K, V >& operator ++(void) { TryReturnResult(!__isPostEnd, *this, E_OUT_OF_RANGE, "[%s] It already reached the end.", GetErrorMessage(E_OUT_OF_RANGE)); result r = __pEnum->MoveNext(); - TryCatchResult(r == E_SUCCESS, __isPostEnd = true; __currentObj.first = null; __currentObj.second = null, + TryCatchResult(r == E_SUCCESS, __isPostEnd = true; + __currentObj.first = null; + __currentObj.second = null, r, "[%s] It already reached the end.", GetErrorMessage(r)); __currentObj.first = static_cast< K >(__pEnum->GetKey()); @@ -250,10 +252,10 @@ CATCH: * 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) + PairIteratorT< K, V > operator ++(int) { PairIteratorT< K, V > tempIter = *this; - operator++(); + operator ++(); return tempIter; } @@ -266,7 +268,7 @@ CATCH: * else @c false * @param[in] rhs A reference to the %PairIteratorT instance on the right-hand side of the operator */ - bool operator==(const PairIteratorT< K, V >& rhs) const + bool operator ==(const PairIteratorT< K, V >& rhs) const { if (__pMap != rhs.__pMap) { @@ -306,9 +308,9 @@ CATCH: * else @c false * @param[in] rhs A reference to the %PairIteratorT instance on the right-hand side of the operator */ - bool operator!=(const PairIteratorT< K, V >& rhs) const + bool operator !=(const PairIteratorT< K, V >& rhs) const { - return !operator==(rhs); + return !operator ==(rhs); } /** @@ -335,7 +337,7 @@ private: int __index; std::unique_ptr< IMapEnumerator > __pEnum; std::pair< K, V > __currentObj; -}; // PairIteratorT +}; // PairIteratorT }}} // Tizen::Base::Collection diff --git a/inc/FBaseColQueue.h b/inc/FBaseColQueue.h index b7d5283..83f353a 100644 --- a/inc/FBaseColQueue.h +++ b/inc/FBaseColQueue.h @@ -28,7 +28,6 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { /** @@ -101,8 +100,8 @@ 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. + * @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. * Therefore, if the size of the queue can be estimated, @@ -119,7 +118,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to copy elements from + * @param[in] collection The collection to copy elements from * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or * the @c collection is modified during the operation of this method. @@ -139,7 +138,7 @@ public: * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or * this queue is empty. * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Enqueue(Object*) + * @see Enqueue(Object*) */ virtual Object* Dequeue(void); @@ -153,11 +152,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj The object to add to this queue + * @param[in] obj The object to add to this queue * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks This method performs a shallow copy. It inserts just the pointer; not the element itself. - * @see Dequeue() + * @see Dequeue() * @endif */ result Enqueue(const Object& obj) @@ -171,11 +170,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to add to this queue - * @exception E_SUCCESS The method is successful. + * @param[in] pObj The pointer to object to add to this queue + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @remarks This method performs a shallow copy. It inserts just the pointer; not the element itself. - * @see Dequeue() + * @see Dequeue() */ virtual result Enqueue(Object* pObj); @@ -187,7 +186,7 @@ public: * @return An 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 + * @see IEnumerator */ virtual IEnumerator* GetEnumeratorN(void) const; @@ -207,7 +206,7 @@ public: /** * Removes all objects and their pointers in collection, when the @c deallocate parameter is set to @c true. - * + * * @since 2.0 * * @param[in] deallocate Set to @c true to deallocate all objects, @n @@ -268,8 +267,8 @@ public: * @since 2.0 * * @return @c true if this queue contains all the elements in the specified collection, @n - * else @c false - * @param[in] collection The collection to locate + * else @c false + * @param[in] collection The collection to locate * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or * the @c collection is modified during the operation of this method. diff --git a/inc/FBaseColQueueT.h b/inc/FBaseColQueueT.h index c47f7ba..42bfe86 100644 --- a/inc/FBaseColQueueT.h +++ b/inc/FBaseColQueueT.h @@ -28,7 +28,6 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { @@ -117,8 +116,8 @@ 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 The specified input parameter is invalid, or + * the specified @c capacity is negative. */ result Construct(int capacity = DEFAULT_CAPACITY) { @@ -141,7 +140,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to copy the elements from + * @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 @@ -201,7 +200,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[out] obj The element at the beginning of this queue + * @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. @@ -227,7 +226,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj The object to add to this queue + * @param[in] obj The object to add to this queue * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @see Dequeue() @@ -318,7 +317,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[out] obj The element at the beginning of this queue + * @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. @@ -377,9 +376,9 @@ CATCH: * @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 of 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 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. @@ -564,13 +563,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 - * - This enumerator is currently positioned before the first element or - * past the last element. @n - * - The queue is modified after this enumerator is created. - * @exception E_SUCCESS The method is successful. + * @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 + * - This enumerator is currently positioned before the first element or + * past the last element. @n + * - The queue is modified after this enumerator is created. + * @exception E_SUCCESS The method is successful. */ result GetCurrent(Type& obj) const { diff --git a/inc/FBaseColRandomIteratorT.h b/inc/FBaseColRandomIteratorT.h index 677bd83..cdfae6d 100644 --- a/inc/FBaseColRandomIteratorT.h +++ b/inc/FBaseColRandomIteratorT.h @@ -24,7 +24,7 @@ #ifndef _FBASE_COL_RANDOM_ITERATOR_T_H_ #define _FBASE_COL_RANDOM_ITERATOR_T_H_ -#include // std::swap (Before C++11) +#include // std::swap (Before C++11) #include #include #include @@ -46,7 +46,7 @@ namespace Tizen { namespace Base { namespace Collection * StlConverter provides static methods to get this random iterator from IList. */ -template < typename T > +template< typename T > class RandomIteratorT : public std::iterator< std::input_iterator_tag, T > { @@ -56,10 +56,10 @@ public: * * @since 2.1 * - * @param[in] list A reference to the IList instance to convert + * @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. - * @see Tizen::Base::Collection::IList::IsRandomAccessible() + * @remarks %RandomIteratorT only supports random accessible collection for performance. + * @see Tizen::Base::Collection::IList::IsRandomAccessible() */ explicit RandomIteratorT(const IList& list, int index = 0) : __pList(&list) @@ -91,7 +91,7 @@ public: * @return A reference to the %RandomIteratorT instance * @param[in] rhs A reference to the %RandomIteratorT instance on the right-hand side of the operator */ - RandomIteratorT< T >& operator=(const RandomIteratorT< T >& rhs) + RandomIteratorT< T >& operator =(const RandomIteratorT< T >& rhs) { RandomIteratorT< T > tmp(rhs); tmp.swap(*this); @@ -105,7 +105,7 @@ public: * * @return A T type reference */ - T& operator*(void) const + T& operator *(void) const { AppAssertf(__index >= 0 && __index < __pList->GetCount(), "It is out of range."); return const_cast< T& >(__currentObj); @@ -118,9 +118,9 @@ public: * * @return A T type pointer equivalent to the pointer address */ - T* operator->(void) const + T* operator ->(void) const { - return &(operator*()); + return &(operator *()); } /** @@ -134,7 +134,7 @@ public: * or the specified index is either equal to or greater than the number of elements in the list or less than 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ - RandomIteratorT< T >& operator++(void) + RandomIteratorT< T >& operator ++(void) { ++__index; @@ -155,10 +155,10 @@ public: * or the specified index is either equal to or greater than the number of elements in the list or less than 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ - RandomIteratorT< T > operator++(int) + RandomIteratorT< T > operator ++(int) { RandomIteratorT< T > tempIter = *this; - operator++(); + operator ++(); return tempIter; } @@ -173,7 +173,7 @@ public: * or the specified index is either equal to or greater than the number of elements in the list or less than 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ - RandomIteratorT< T >& operator--(void) + RandomIteratorT< T >& operator --(void) { --__index; @@ -194,10 +194,10 @@ public: * or the specified index is either equal to or greater than the number of elements in the list or less than 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ - RandomIteratorT< T > operator--(int) + RandomIteratorT< T > operator --(int) { RandomIteratorT< T > tempIter = *this; - operator--(); + operator --(); return tempIter; } @@ -210,7 +210,7 @@ public: * else @c false * @param[in] rhs A reference to the %RandomIteratorT instance on the right-hand side of the operator */ - bool operator==(const RandomIteratorT< T >& rhs) const + bool operator ==(const RandomIteratorT< T >& rhs) const { return ((__pList == rhs.__pList) && (__index == rhs.__index) && (__currentObj == rhs.__currentObj)); } @@ -224,13 +224,13 @@ public: * else @c false * @param[in] rhs A reference to the %RandomIteratorT instance on the right-hand side of the operator */ - bool operator!=(const RandomIteratorT< T >& rhs) const + bool operator !=(const RandomIteratorT< T >& rhs) const { - return !operator==(rhs); + return !operator ==(rhs); } /** - * Checks l-value is less than r-value. + * Checks l-value is less than r-value. * * @since 2.1 * @@ -238,7 +238,7 @@ public: * else @c false * @param[in] rhs A reference to the %RandomIteratorT instance on the right-hand side of the operator */ - bool operator<(const RandomIteratorT< T >& rhs) const + bool operator <(const RandomIteratorT< T >& rhs) const { return __index < rhs.__index; } @@ -252,7 +252,7 @@ public: * else @c false * @param[in] rhs A reference to the %RandomIteratorT instance on the right-hand side of the operator */ - bool operator>(const RandomIteratorT< T >& rhs) const + bool operator >(const RandomIteratorT< T >& rhs) const { return __index > rhs.__index; } @@ -263,13 +263,13 @@ public: * @since 2.1 * * @return A %RandomIteratorT instance - * @param[in] diff The length to move forward + * @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. * @remarks The specific error code can be accessed using GetLastResult() method. */ - RandomIteratorT< T > operator+(int diff) + RandomIteratorT< T > operator +(int diff) { RandomIteratorT< T > tempIter = *this; tempIter.__index += diff; @@ -286,13 +286,13 @@ public: * @since 2.1 * * @return A %RandomIteratorT instance - * @param[in] diff The length to move backward + * @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. * @remarks The specific error code can be accessed using GetLastResult() method. */ - RandomIteratorT< T > operator-(int diff) + RandomIteratorT< T > operator -(int diff) { RandomIteratorT< T > tempIter = *this; tempIter.__index -= diff; @@ -303,7 +303,7 @@ public: return tempIter; } - int operator-(const RandomIteratorT< T >& rhs) + int operator -(const RandomIteratorT< T >& rhs) { return __index - rhs.__index; } @@ -314,13 +314,13 @@ public: * @since 2.1 * * @return A reference to the T type instance - * @param[in] index An index to reach + * @param[in] index An 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. * @remarks The specific error code can be accessed using GetLastResult() method. */ - T& operator[](int index) const + T& operator [](int index) const { // GetAt() will return null if __index is out of range. const T& tempObj = static_cast< T >(const_cast< Object* >(__pList->GetAt(index))); diff --git a/inc/FBaseColStack.h b/inc/FBaseColStack.h index 0b63db5..15fb460 100644 --- a/inc/FBaseColStack.h +++ b/inc/FBaseColStack.h @@ -28,7 +28,6 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { @@ -101,11 +100,11 @@ public: * @since 2.0 * * @return An error code - * @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. + * @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, * the capacity is automatically increased by memory reallocation. @n * Therefore, if the size of the stack can be estimated, @@ -122,7 +121,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to copy elements from + * @param[in] collection The collection to copy elements from * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or * the @c collection is modified during the operation of this method. @@ -139,7 +138,7 @@ public: * @return An 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 + * @see IEnumerator */ virtual IEnumerator* GetEnumeratorN(void) const; @@ -168,7 +167,7 @@ public: * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or * this stack is empty. * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Push(Object*) + * @see Push(Object*) */ virtual Object* Pop(void); @@ -182,11 +181,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj The object to add to this stack + * @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. - * @see Pop() + * @see Pop() * @endif */ result Push(const Object& obj) @@ -200,11 +199,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to add to this stack + * @param[in] pObj The pointer to 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. - * @see Pop() + * @see Pop() */ virtual result Push(Object* pObj); @@ -251,8 +250,8 @@ public: * * @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[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. @@ -271,8 +270,8 @@ public: * @since 2.0 * * @return @c true if this stack contains all the elements in the specified collection, @n - * else @c false - * @param[in] collection The collection to locate + * else @c false + * @param[in] collection The collection to locate * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or * the @c collection is modified during the operation of this method. diff --git a/inc/FBaseColStackT.h b/inc/FBaseColStackT.h index 35cdc66..fe62e83 100644 --- a/inc/FBaseColStackT.h +++ b/inc/FBaseColStackT.h @@ -28,7 +28,6 @@ #include #include - namespace Tizen { namespace Base { namespace Collection { @@ -116,7 +115,7 @@ public: * 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. + * the specified @c capacity is negative. */ result Construct(int capacity = DEFAULT_CAPACITY) { @@ -139,7 +138,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to copy elements from + * @param[in] collection The collection to copy elements from * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or * the specified @c collection is modified during the operation of this method. @@ -203,7 +202,7 @@ CATCH: * @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 + * @see Tizen::Base::Collection::IEnumeratorT */ virtual IEnumeratorT< Type >* GetEnumeratorN(void) const { @@ -227,7 +226,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[out] obj The element at the beginning of this stack + * @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. @@ -250,7 +249,7 @@ CATCH: * @since 2.0 * * @return An error code - * @param[out] obj The element at the beginning of this stack + * @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. @@ -278,10 +277,10 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj The object to add to this stack + * @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. - * @see Pop() + * @see Pop() */ virtual result Push(const Type& obj) { @@ -383,8 +382,8 @@ CATCH: * * @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[out] out Set to @c true if this stack contains all of the elements in 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 specified @c collection is modified during the operation of this method. @@ -569,13 +568,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 - * - This enumerator is currently positioned before the first element or - * past the last element. @n - * - The stack is modified after this enumerator is created. - * @exception E_SUCCESS The method is successful. + * @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 + * - This enumerator is currently positioned before the first element or + * past the last element. @n + * - The stack is modified after this enumerator is created. + * @exception E_SUCCESS The method is successful. */ result GetCurrent(Type& obj) const { @@ -601,7 +600,7 @@ public: * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or * the stack is modified after this enumerator is created. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the stack. - * @see Reset() + * @see Reset() */ result MoveNext(void) {