string.h: Fix indentation, add doxygen reference.
authorAndre Noll <maan@tuebingen.mpg.de>
Sat, 5 Aug 2017 18:01:27 +0000 (20:01 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Mon, 7 Aug 2017 22:39:04 +0000 (00:39 +0200)
The comment was improperly formatted, and the reference to
para_printf() lacked a \ref statement.

string.h

index 93bb6cb..a409300 100644 (file)
--- a/string.h
+++ b/string.h
@@ -52,14 +52,14 @@ int for_each_line(unsigned flags, char *buf, size_t size,
                line_handler_t *line_handler, void *private_data);
 
 /**
 * Write the contents of a status item to a para_buffer.
 *
 * \param b The para_buffer.
 * \param n The number of the status item.
 * \param f A format string.
 *
 * \return The return value of the underlying call to para_printf().
 */
+ * Write the contents of a status item to a para_buffer.
+ *
+ * \param b The para_buffer.
+ * \param n The number of the status item.
+ * \param f A format string.
+ *
* \return The return value of the underlying call to \ref para_printf().
+ */
 #define WRITE_STATUS_ITEM(b, n, f, ...) (\
 { \
        if ((b)->flags & PBF_SIZE_PREFIX) { \