[glib] gprintf: Add a reminder concerning <glib/gprintf.h>
- From: Philip Withnall <pwithnall src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] gprintf: Add a reminder concerning <glib/gprintf.h>
- Date: Thu, 5 Oct 2017 14:03:00 +0000 (UTC)
commit d3745d14e16148a41118557735669b12d860a3f7
Author: Martin Blanchard <tchaik gmx com>
Date: Sat Jan 16 16:08:49 2016 +0100
gprintf: Add a reminder concerning <glib/gprintf.h>
g_printf(), g_fprintf(), g_sprintf(), g_vprintf(), g_vfprintf(),
() and g_vasprintf() require gprintf.h to be explicitly included
in order to be used. This patch adds a reminder in each function's
documentation abstract.
https://bugzilla.gnome.org/show_bug.cgi?id=760716
glib/gprintf.c | 14 ++++++++++++++
1 files changed, 14 insertions(+), 0 deletions(-)
---
diff --git a/glib/gprintf.c b/glib/gprintf.c
index 2d41f2b..9293c83 100644
--- a/glib/gprintf.c
+++ b/glib/gprintf.c
@@ -38,6 +38,8 @@
* new-line character to the message, so typically @format should end with its
* own new-line character.
*
+ * `glib/gprintf.h` must be explicitly included in order to use this function.
+ *
* Returns: the number of bytes printed.
*
* Since: 2.2
@@ -66,6 +68,8 @@ g_printf (gchar const *format,
* An implementation of the standard fprintf() function which supports
* positional parameters, as specified in the Single Unix Specification.
*
+ * `glib/gprintf.h` must be explicitly included in order to use this function.
+ *
* Returns: the number of bytes printed.
*
* Since: 2.2
@@ -100,6 +104,8 @@ g_fprintf (FILE *file,
* Note that it is usually better to use g_snprintf(), to avoid the
* risk of buffer overflow.
*
+ * `glib/gprintf.h` must be explicitly included in order to use this function.
+ *
* See also g_strdup_printf().
*
* Returns: the number of bytes printed.
@@ -176,6 +182,8 @@ g_snprintf (gchar *string,
* An implementation of the standard vprintf() function which supports
* positional parameters, as specified in the Single Unix Specification.
*
+ * `glib/gprintf.h` must be explicitly included in order to use this function.
+ *
* Returns: the number of bytes printed.
*
* Since: 2.2
@@ -199,6 +207,8 @@ g_vprintf (gchar const *format,
* An implementation of the standard fprintf() function which supports
* positional parameters, as specified in the Single Unix Specification.
*
+ * `glib/gprintf.h` must be explicitly included in order to use this function.
+ *
* Returns: the number of bytes printed.
*
* Since: 2.2
@@ -223,6 +233,8 @@ g_vfprintf (FILE *file,
* An implementation of the standard vsprintf() function which supports
* positional parameters, as specified in the Single Unix Specification.
*
+ * `glib/gprintf.h` must be explicitly included in order to use this function.
+ *
* Returns: the number of bytes printed.
*
* Since: 2.2
@@ -293,6 +305,8 @@ g_vsnprintf (gchar *string,
* string to hold the output, instead of putting the output in a buffer
* you allocate in advance.
*
+ * `glib/gprintf.h` must be explicitly included in order to use this function.
+ *
* Returns: the number of bytes printed.
*
* Since: 2.4
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]