Mercurial > hg > ucx / changeset

--- a/src/cx/streams.h	Sat Jan 04 18:40:29 2025 +0100
+++ b/src/cx/streams.h	Sat Jan 04 18:44:11 2025 +0100
@@ -27,13 +27,13 @@
  */
 
 /**
- * \file streams.h
+ * @file streams.h
  *
- * \brief Utility functions for data streams.
+ * @brief Utility functions for data streams.
  *
- * \author Mike Becker
- * \author Olaf Wintermann
- * \copyright 2-Clause BSD License
+ * @author Mike Becker
+ * @author Olaf Wintermann
+ * @copyright 2-Clause BSD License
  */
 
 #ifndef UCX_STREAMS_H
@@ -52,12 +52,12 @@
  * @param dest the destination stream
  * @param rfnc the read function
  * @param wfnc the write function
- * @param buf a pointer to the copy buffer or \c NULL if a buffer
+ * @param buf a pointer to the copy buffer or @c NULL if a buffer
  * shall be implicitly created on the heap
- * @param bufsize the size of the copy buffer - if \p buf is \c NULL you can
+ * @param bufsize the size of the copy buffer - if @p buf is @c NULL you can
  * set this to zero to let the implementation decide
  * @param n the maximum number of bytes that shall be copied.
- * If this is larger than \p bufsize, the content is copied over multiple
+ * If this is larger than @p bufsize, the content is copied over multiple
  * iterations.
  * @return the total number of bytes copied
  */
@@ -78,14 +78,14 @@
 /**
  * Reads data from a stream and writes it to another stream.
  *
- * @param src the source stream
- * @param dest the destination stream
- * @param rfnc the read function
- * @param wfnc the write function
- * @param buf a pointer to the copy buffer or \c NULL if a buffer
+ * @param src (@c void*) the source stream
+ * @param dest (@c void*) the destination stream
+ * @param rfnc (@c cx_read_func) the read function
+ * @param wfnc (@c cx_write_func) the write function
+ * @param buf (@c char*) a pointer to the copy buffer or @c NULL if a buffer
  * shall be implicitly created on the heap
- * @param bufsize the size of the copy buffer - if \p buf is \c NULL you can
- * set this to zero to let the implementation decide
+ * @param bufsize (@c size_t) the size of the copy buffer - if @p buf is
+ * @c NULL you can set this to zero to let the implementation decide
  * @return total number of bytes copied
  */
 #define cx_stream_bcopy(src, dest, rfnc, wfnc, buf, bufsize) \
@@ -119,10 +119,10 @@
  *
  * The data is temporarily stored in a stack allocated buffer.
  *
- * @param src the source stream
- * @param dest the destination stream
- * @param rfnc the read function
- * @param wfnc the write function
+ * @param src (@c void*) the source stream
+ * @param dest (@c void*) the destination stream
+ * @param rfnc (@c cx_read_func) the read function
+ * @param wfnc (@c cx_write_func) the write function
  * @return total number of bytes copied
  */
 #define cx_stream_copy(src, dest, rfnc, wfnc) \