ggo.c: Document return value of printf_or_die().

Commit b59a3c41 (filter: Wrap lines in the available filter list)
changed the return value of this function from void to int but missed
to update the documentation.

diff --git a/ggo.c b/ggo.c
index 58d86d0796adec72bf3ea134532b9bc3c80bea07..99171c73457d150cb2f4b193f5fe20df0025e662 100644 (file)
--- a/ggo.c
+++ b/ggo.c
@@ -15,6 +15,9 @@
  * Wrapper for printf() that exits on errors.
  *
  * \param fmt Usual format string.
  * 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, ...)
 {
  */
 __printf_1_2 int printf_or_die(const char *fmt, ...)
 {