X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/e81e4e8d1c49737e12e3ca5dba36fd1453f447bb..refs/remotes/upstream/release:/lib/snprintf.c

diff --git a/lib/snprintf.c b/lib/snprintf.c
index e62e3c9..f272dc7 100644
--- a/lib/snprintf.c
+++ b/lib/snprintf.c
@@ -30,10 +30,21 @@
 #include "printf.h"
 #include "sink.h"
 
+/** @brief A @ref sink that stores to a fixed buffer
+ *
+ * If there is too much output, it is truncated.
+ */
 struct fixedstr_sink {
+  /** @brief Base */
   struct sink s;
+
+  /** @brief Output buffer */
   char *buffer;
+
+  /** @brief Bytes written so far */
   int nbytes;
+
+  /** @brief Size of buffer */
   size_t size;
 };