void Clear(void);
/**
- * Copies the elements between the current position and limit (that are also known as remaining
+ * Copies the elements between the current position and the limit (that are also known as the remaining
* elements), to the beginning of the calling %BufferBase instance.
*
* @since 2.0
*
* @remarks After copying, the position is set to the number of elements copied rather than to @c 0,
* so that an invocation of this method can be followed immediately by an invocation
- * of another relative set method. The limit is set to the capacity, and the mark is discarded.
+ * of another relative set method. @n
+ * The limit is set to the capacity, and the mark is discarded.
*/
void Compact(void);
*
* @since 2.0
*
- * @param[in] to The value to set the buffer position @n
+ * @param[in] to The value of the buffer position to set @n
* The parameter may contain @c POSITION_TO_ZERO or @c POSITION_TO_MARK.
- * @remarks If @c to is POSITION_TO_ZERO (or unspecified), the position is set to @c 0 after setting a limit to
+ * @remarks If @c to is @c POSITION_TO_ZERO (or unspecified), the position is set to @c 0 after setting a limit to
* the current position, and the mark is discarded.
- * Otherwise, if @c to is POSITION_TO_MARK, the position is set to the mark and
- * the mark is not discarded. If the mark is undefined, the position is set to @c 0.
+ * Otherwise, if @c to is @c POSITION_TO_MARK, the position is set to the mark and
+ * the mark is not discarded. @n
+ * If the mark is undefined, the position is set to @c 0.
*
* The following example demonstrates how to use the %Flip() method.
*
* @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;
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The mark has not been set.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The mark has not been set.
* @remarks Invoking this method neither changes nor discards the mark's value.
*/
result Reset(void);
/**
* Shifts the limit of the current instance of %BufferBase. @n
- * The new limit is the current limit plus the given amount.
+ * The new limit is the current limit plus the given @c amount.
*
* @since 2.0
*
* @return An error code
- * @param[in] amount The quantity of shift needed
+ * @param[in] amount The quantity of the shift needed
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method. @n
- * The @c amount is larger than the capacity or smaller than @c 0 starting from the current limit.
- * @remarks If the position is larger than the new limit, it is set to the new limit.
- * If the mark is defined and larger than the new limit, it is discarded.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - The @c amount is larger than the capacity starting from the current limit.
+ * - The @c amount is smaller than @c 0.
+ * @remarks
+ * - If the position is larger than the new limit, it is set to the new limit.
+ * - If the mark is defined and is larger than the new limit, it is discarded.
* @see SetLimit()
*/
result ShiftLimit(int amount);
*
* @since 2.0
*
- * @return The capacity of the calling object
+ * @return The capacity of the calling %BufferBase instance
*/
int GetCapacity(void) const;
*
* @since 2.0
*
- * @return The limit of the calling object
+ * @return The limit of the calling %BufferBase instance
* @see SetLimit()
*/
int GetLimit(void) const;
* @since 2.0
*
* @return An error code
- * @param[in] limit The new limit
+ * @param[in] limit The limit of the calling %BufferBase instance
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method. @n
- * The @c limit is larger than the capacity or less than @c 0.
- * @remarks If the position is larger than the new limit, it is set to the new limit.
- * If the mark is defined and larger than the new limit, it is discarded.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - The specified @c limit is larger than the capacity.
+ * - The specified @c limit is less than @c 0.
+ * @remarks
+ * - If the position is larger than the new limit, it is set to the new limit.
+ * - If the mark is defined and is larger than the new limit, it is discarded.
* @see GetLimit()
*/
result SetLimit(int limit);
/**
* Sets the mark of the current instance of %BufferBase at the current position. @n
- * If this method is called after InvalidateMark(), the mark is set to @c -1.
+ * If this method is called after the InvalidateMark() method , the mark is set to @c -1.
*
- * @since 2.0
+ * @since 2.0
*
* @see GetMark()
*/
* @since 2.0
*
* @return An error code
- * @param[in] position The new position
+ * @param[in] position The position of the calling %BufferBase instance
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method. @n
- * The @c position is larger than the current limit or less than @c 0.
- * @remarks If the mark is defined and larger than the new position then it is discarded.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - The specified @c position is larger than the current limit.
+ * - The specified @c position is less than @c 0.
+ * @remarks If the mark is defined and is larger than the new position then it is discarded.
* @see GetPosition()
*/
result SetPosition(int position);
/**
* Returns @c true if there is at least one element between the current position and
- * the limit of the current instance of %BufferBase. Otherwise, it returns @c false.
+ * the limit of the current %BufferBase instance. Otherwise, it returns @c false.
*
* @since 2.0
*
- * @return @c true if there is at least one element between the current position and the limit of the current instance of %BufferBase, @n
+ * @return @c true if there is at least one element between the current position and the limit of the current %BufferBase instance, @n
* else @c false
* @see GetRemaining()
*/
bool HasRemaining(void) const;
/**
- * Expands the capacity and the limit of the internal buffer with the specified capacity.
+ * Expands the capacity and the limit of the internal buffer with the specified @c newCapacity.
*
* @since 2.0
*
* @return An error code
* @param[in] newCapacity The new capacity of this instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c capacity is less than the current capacity.
+ * @exception E_INVALID_ARG The specified @c newCapacity is less than the current capacity.
* @remarks After calling this method, the address of the internal buffer may be either the same or a new location.
*/
result ExpandCapacity(int newCapacity);
virtual ~_BufferData(void);
//
- // Gets the pointer to the byte array.
+ // Gets a pointer to the byte array.
//
// @since 2.0
// @return Pointer to the @c byte array
projects / platform / framework / native / appfw.git / blobdiff