ucx: comparison src/cx/buffer.h

-:9e6900b1cf9d
+:6a86ad3d8c03
 size_t capacity;
 /** Current size of the buffer content. */
 size_t size;
 /**
 * Flag register for buffer features.
-* \see #CX_BUFFER_DEFAULT
+* @see #CX_BUFFER_DEFAULT
-* \see #CX_BUFFER_FREE_CONTENTS
+* @see #CX_BUFFER_FREE_CONTENTS
-* \see #CX_BUFFER_AUTO_EXTEND
+* @see #CX_BUFFER_AUTO_EXTEND
 */
 int flags;
 } cx_buffer_s;
 /**
 *
 * \note You may provide \c NULL as argument for \p space.
 * Then this function will allocate the space and enforce
 * the #CX_BUFFER_FREE_CONTENTS flag.
 *
-* \param space pointer to the memory area, or <code>NULL</code> to allocate
+* @param space pointer to the memory area, or <code>NULL</code> to allocate
 * new memory
-* \param capacity the capacity of the buffer
+* @param capacity the capacity of the buffer
-* \param flags buffer features (see cx_buffer_s.flags)
+* @param flags buffer features (see cx_buffer_s.flags)
-* \return the new buffer
+* @return the new buffer
 */
 CxBuffer cxBufferCreate(
 void *space,
 size_t capacity,
 int flags
 * Destroys a buffer.
 *
 * If the #CX_BUFFER_FREE_CONTENTS feature is enabled, the contents of the buffer
 * are also freed.
 *
-* \param buffer the buffer to destroy
+* @param buffer the buffer to destroy
 */
 void cxBufferDestroy(CxBuffer buffer);
 /**
 * Creates a new buffer and fills it with content copied from another buffer.
 *
 * \note The #CX_BUFFER_FREE_CONTENTS feature is enforced for the new buffer.
 *
-* \param src the source buffer
+* @param src the source buffer
-* \param start the start position of extraction
+* @param start the start position of extraction
-* \param length the count of bytes to extract (must not be zero)
+* @param length the count of bytes to extract (must not be zero)
-* \param flags features for the new buffer (#CX_BUFFER_FREE_CONTENTS will always be enabled)
+* @param flags features for the new buffer (#CX_BUFFER_FREE_CONTENTS will always be enabled)
-* \return a new buffer containing the extraction
+* @return a new buffer containing the extraction
 */
 CxBuffer cxBufferExtract(
 CxBuffer src,
 size_t start,
 size_t length,
 );
 /**
 * A shorthand macro for copying an entire buffer.
 *
-* \param src the source buffer
+* @param src the source buffer
-* \param flags features for the new buffer (#CX_BUFFER_FREE_CONTENTS will always be enabled)
+* @param flags features for the new buffer (#CX_BUFFER_FREE_CONTENTS will always be enabled)
-* \return a new buffer with the copied content
+* @return a new buffer with the copied content
 */
 #define cxBufferClone(src, flags) cxBufferExtract(src, 0, (src)->capacity, flags)
 /**
 * within the boundaries of the buffer.
 *
 * \note For situations where \c off_t is not large enough, there are specialized cxBufferShiftLeft() and
 * cxBufferShiftRight() functions using a \c size_t as parameter type.
 *
-* \par Security Note
+* \attention
-* The shifting operation does \em not erase the previously occupied memory cells.
+* Security Note: The shifting operation does \em not erase the previously occupied memory cells.
-* You can easily do that manually, e.g. by calling
+* But you can easily do that manually, e.g. by calling
 * <code>memset(buffer->bytes, 0, shift)</code> for a right shift or
 * <code>memset(buffer->size, 0, buffer->capacity - buffer->size)</code>
 * for a left shift.
 *
-* \param buffer the buffer
+* @param buffer the buffer
-* \param shift the shift offset (negative means left shift)
+* @param shift the shift offset (negative means left shift)
-* \return 0 on success, non-zero if a required auto-extension fails
+* @return 0 on success, non-zero if a required auto-extension fails
 */
 int cxBufferShift(
 CxBuffer buffer,
 off_t shift
 );
 /**
 * Shifts the buffer to the right.
 * See cxBufferShift() for details.
 *
-* \param buffer the buffer
+* @param buffer the buffer
-* \param shift the shift offset
+* @param shift the shift offset
-* \return 0 on success, non-zero if a required auto-extension fails
+* @return 0 on success, non-zero if a required auto-extension fails
-* \see cxBufferShift()
+* @see cxBufferShift()
 */
 int cxBufferShiftRight(
 CxBuffer buffer,
 size_t shift
 );
 * See cxBufferShift() for details.
 *
 * \note Since a left shift cannot fail due to memory allocation problems, this
 * function always returns zero.
 *
-* \param buffer the buffer
+* @param buffer the buffer
-* \param shift the positive shift offset
+* @param shift the positive shift offset
-* \return always zero
+* @return always zero
-* \see cxBufferShift()
+* @see cxBufferShift()
 */
 int cxBufferShiftLeft(
 CxBuffer buffer,
 size_t shift
 );
 *
 * With an offset of zero, this function sets the buffer position to zero
 * (\c SEEK_SET), the buffer size (\c SEEK_END) or leaves the buffer position
 * unchanged (\c SEEK_CUR).
 *
-* \param buffer the buffer
+* @param buffer the buffer
-* \param offset position offset relative to \p whence
+* @param offset position offset relative to \p whence
-* \param whence one of \c SEEK_SET, \c SEEK_CUR or \c SEEK_END
+* @param whence one of \c SEEK_SET, \c SEEK_CUR or \c SEEK_END
-* \return 0 on success, non-zero if the position is invalid
+* @return 0 on success, non-zero if the position is invalid
 *
 */
 int cxBufferSeek(
 CxBuffer buffer,
 off_t offset,
 /**
 * Clears the buffer by resetting the position and deleting the data.
 *
 * The data is deleted by zeroing it with a call to memset().
 *
-* \param buffer the buffer to be cleared
+* @param buffer the buffer to be cleared
 */
 #define cxBufferClear(buffer) memset((buffer)->bytes, 0, (buffer)->size); \
 (buffer)->size = 0; (buffer)->pos = 0;
 /**
 * Tests, if the buffer position has exceeded the buffer capacity.
 *
-* \param buffer the buffer to test
+* @param buffer the buffer to test
-* \return non-zero, if the current buffer position has exceeded the last
+* @return non-zero, if the current buffer position has exceeded the last
 * available byte of the buffer.
 */
 int cxBufferEof(CxBuffer buffer);
 /**
 * Ensures that the buffer has a minimum capacity.
 *
 * If the current capacity is not sufficient, the buffer will be extended.
 *
-* \param buffer the buffer
+* @param buffer the buffer
-* \param capacity the minimum required capacity for this buffer
+* @param capacity the minimum required capacity for this buffer
-* \return 0 on success or a non-zero value on failure
+* @return 0 on success or a non-zero value on failure
 */
 int cxBufferMinimumCapacity(
 CxBuffer buffer,
 size_t capacity
 );
 *
 * The position of the buffer is increased by the number of bytes written.
 *
 * \note The signature is compatible with the fwrite() family of functions.
 *
-* \param ptr a pointer to the memory area containing the bytes to be written
+* @param ptr a pointer to the memory area containing the bytes to be written
-* \param size the length of one element
+* @param size the length of one element
-* \param nitems the element count
+* @param nitems the element count
-* \param buffer the CxBuffer to write to
+* @param buffer the CxBuffer to write to
-* \return the total count of bytes written
+* @return the total count of bytes written
 */
 size_t cxBufferWrite(
 const void *ptr,
 size_t size,
 size_t nitems,
 *
 * The position of the buffer is increased by the number of bytes read.
 *
 * \note The signature is compatible with the fread() family of functions.
 *
-* \param ptr a pointer to the memory area where to store the read data
+* @param ptr a pointer to the memory area where to store the read data
-* \param size the length of one element
+* @param size the length of one element
-* \param nitems the element count
+* @param nitems the element count
-* \param buffer the CxBuffer to read from
+* @param buffer the CxBuffer to read from
-* \return the total number of elements read
+* @return the total number of elements read
 */
 size_t cxBufferRead(
 void *ptr,
 size_t size,
 size_t nitems,
 * the buffer capacity is extended by cxBufferMinimumCapacity(). If the feature is
 * disabled or buffer extension fails, \c EOF is returned.
 *
 * On successful write, the position of the buffer is increased.
 *
-* \param buffer the buffer to write to
+* @param buffer the buffer to write to
-* \param c the character to write
+* @param c the character to write
-* \return the byte that has bean written or \c EOF when the end of the stream is
+* @return the byte that has bean written or \c EOF when the end of the stream is
 * reached and automatic extension is not enabled or not possible
 */
 int cxBufferPut(
 CxBuffer buffer,
 int c
 /**
 * Gets a character from a buffer.
 *
 * The current position of the buffer is increased after a successful read.
 *
-* \param buffer the buffer to read from
+* @param buffer the buffer to read from
-* \return the character or \c EOF, if the end of the buffer is reached
+* @return the character or \c EOF, if the end of the buffer is reached
 */
 int cxBufferGet(CxBuffer buffer);
 /**
 * Writes a string to a buffer.
 *
-* \param buffer the buffer
+* @param buffer the buffer
-* \param str the zero-terminated string
+* @param str the zero-terminated string
-* \return the number of bytes written
+* @return the number of bytes written
 */
 size_t cxBufferPutString(
 CxBuffer buffer,
 const char *str
 );

Mercurial > hg > ucx / file comparison

comparison: src/cx/buffer.h

src/cx/buffer.h