ggo.c: Document return value of printf_or_die().
[paraslash.git] / ggo.c
diff --git a/ggo.c b/ggo.c
index 58d86d0..99171c7 100644 (file)
--- a/ggo.c
+++ b/ggo.c
@@ -15,6 +15,9 @@
  * Wrapper for printf() that exits on errors.
  *
  * \param fmt Usual format string.
+ *
+ * \return The return value of the underlying (successful) call to vprintf(3),
+ * i.e. the number of characters printed, excluding the terminating null byte.
  */
 __printf_1_2 int printf_or_die(const char *fmt, ...)
 {