//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
- * Initializes this instance of %Buffer which is a view of the specified buffer. @n
+ * Initializes this instance of %Buffer which is a view of the specified @c buffer. @n
* This is similar to a copy constructor.
*
* @since 2.0
}
/**
- * Initializes this instance of %Buffer with the specified capacity.
+ * Initializes this instance of %Buffer with the specified @c capacity.
*
* @since 2.0
*
* @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
+ * @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)
}
/**
- * This subscript operator returns the reference to the element indicated by the given index.
+ * This subscript operator returns the reference to the element indicated by the given @c index.
*
* @since 2.0
*
* @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
* and the two sequences of remaining elements are equal (considered independently of their starting positions).
* @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
* number of remaining elements and the two sequences of remaining elements are equal @n
}
/**
- * Reads the value at the given index. @n
+ * Reads the value at the given @c index. @n
* Provides a way for absolute indexing and reading.
*
* @since 2.0
/**
- * Copies the specified range of values from the calling buffer to the specified destination array as per the given index of the array.
+ * Copies the specified range of values from the calling buffer to the specified destination array as per the given @c index of the array.
*
* @since 2.0
*
* @since 2.0
*
* @return An error code
- * @param[in] buffer The source buffer from which bytes are read @n
+ * @param[in] buffer The source buffer from where the bytes are read @n
* It must not be this buffer.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
* between the number of elements remaining in the calling buffer and the source buffer). @n
* If there are more elements remaining in the calling buffer than elements remaining in the input instance,
* this method is equivalent to CopyFrom() method. If there are less remaining elements in the
- * calling buffer, the CopyFrom() method returns E_OVERFLOW and does not transfer
+ * calling buffer, the %CopyFrom() method returns @c E_OVERFLOW and does not transfer
* while this method copies the number of remaining elements of the current instance.
* @see CopyFrom()
*
/**
- * Writes the specified value into the current buffer instance at the current position,
+ * Writes the specified @c value into the current buffer instance at the current position,
* and then increments the position. @n
* Provides a way for relative indexing and writing.
*
}
/**
- * Writes the specified value into the current instance of buffer at the given index. @n
+ * Writes the specified @c value into the current instance of buffer at the given @c index. @n
* Provides a way for absolute indexing and writing.
*
* @since 2.0
* @since 2.0
*
* @return An error code
- * @param[in] pArray A pointer to the array from which values are read
+ * @param[in] pArray A pointer to the array from where the values are read
* @param[in] index The starting index of the array
* @param[in] length The number of values read from the given array
* @exception E_SUCCESS The method is successful.
* @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow. @n
* The remainder of this buffer is smaller than @c length.
* @remarks This method copies @c length number of values from the source array,
- * starting from the given index in the array, into the calling
+ * 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.
* @see GetArray()
/**
- * The @c double buffer type.
+ * The @c double buffer type
* @since 2.0
*/
typedef Buffer <double> DoubleBuffer;
/**
-* The @c float buffer type.
+* The @c float buffer type
* @since 2.0
*/
typedef Buffer <float> FloatBuffer;
/**
-* The @c int buffer type.
+* The @c int buffer type
* @since 2.0
*/
typedef Buffer <int> IntBuffer;
/**
-* The @c long buffer type.
+* The @c long buffer type
* @since 2.0
*/
typedef Buffer <long> LongBuffer;
/**
-* The @c long @c long buffer type.
+* The @c long @c long buffer type
* @since 2.0
*/
typedef Buffer <long long> LongLongBuffer;
/**
-* The @c wchar_t buffer type.
+* The @c wchar_t buffer type
* @since 2.0
*/
typedef Buffer <wchar_t> WcharBuffer;
/**
-* The @c short buffer type.
+* The @c short buffer type
* @since 2.0
*/
typedef Buffer <short> ShortBuffer;
projects / platform / framework / native / appfw.git / blobdiff