//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
*
* This header file contains the declarations of the %BufferBase class.
*/
-
#ifndef _FBASE_BUFFER_BASE_H_
#define _FBASE_BUFFER_BASE_H_
*
* @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.
*/
*
* @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.
* @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
+ * @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);
* @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()
*/
*
* @since 2.0
*
- * @return The limit of the calling object
+ * @return The limit of the calling object
* @see SetLimit()
*/
int GetLimit(void) const;
*
* @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;
*
* @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;
*
* @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;
* @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()
*/
* @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);
* @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;
*
* @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);
BufferBase(void);
/**
- * Initializes this instance of %BufferBase with the specified capacity.
+ * Initializes this instance of %BufferBase with the specified @c capacity.
*
* @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);
BufferBase& operator =(const BufferBase& rhs);
friend class _BufferBaseImpl;
- class _BufferBaseImpl * __pBufferBaseImpl;
+ class _BufferBaseImpl* __pBufferBaseImpl;
}; // BufferBase
projects / platform / framework / native / appfw.git / blobdiff