luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-13 21:06:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

gprintf: Add a reminder concerning <glib/gprintf.h>

Browse Source 
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
This commit is contained in:
Martin Blanchard 2016-01-16 16:08:49 +01:00 committed by Philip Withnall
parent c443adeffb
commit d3745d14e1
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
glib/gprintf.c
View File

@ -38,6 +38,8 @@
* new-line character to the message, so typically @format should end with its * new-line character to the message, so typically @format should end with its
* own new-line character. * own new-line character.
* *
* `glib/gprintf.h` must be explicitly included in order to use this function.
*
* Returns: the number of bytes printed. * Returns: the number of bytes printed.
* *
* Since: 2.2 * Since: 2.2
@ -66,6 +68,8 @@ g_printf (gchar const *format,
* An implementation of the standard fprintf() function which supports * An implementation of the standard fprintf() function which supports
* positional parameters, as specified in the Single Unix Specification. * 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. * Returns: the number of bytes printed.
* *
* Since: 2.2 * Since: 2.2
@ -100,6 +104,8 @@ g_fprintf (FILE *file,
* Note that it is usually better to use g_snprintf(), to avoid the * Note that it is usually better to use g_snprintf(), to avoid the
* risk of buffer overflow. * risk of buffer overflow.
* *
* `glib/gprintf.h` must be explicitly included in order to use this function.
*
* See also g_strdup_printf(). * See also g_strdup_printf().
* *
* Returns: the number of bytes printed. * Returns: the number of bytes printed.
@ -176,6 +182,8 @@ g_snprintf (gchar *string,
* An implementation of the standard vprintf() function which supports * An implementation of the standard vprintf() function which supports
* positional parameters, as specified in the Single Unix Specification. * 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. * Returns: the number of bytes printed.
* *
* Since: 2.2 * Since: 2.2
@ -199,6 +207,8 @@ g_vprintf (gchar const *format,
* An implementation of the standard fprintf() function which supports * An implementation of the standard fprintf() function which supports
* positional parameters, as specified in the Single Unix Specification. * 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. * Returns: the number of bytes printed.
* *
* Since: 2.2 * Since: 2.2
@ -223,6 +233,8 @@ g_vfprintf (FILE *file,
* An implementation of the standard vsprintf() function which supports * An implementation of the standard vsprintf() function which supports
* positional parameters, as specified in the Single Unix Specification. * 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. * Returns: the number of bytes printed.
* *
* Since: 2.2 * Since: 2.2
@ -293,6 +305,8 @@ g_vsnprintf (gchar *string,
* string to hold the output, instead of putting the output in a buffer * string to hold the output, instead of putting the output in a buffer
* you allocate in advance. * you allocate in advance.
* *
* `glib/gprintf.h` must be explicitly included in order to use this function.
*
* Returns: the number of bytes printed. * Returns: the number of bytes printed.
* *
* Since: 2.4 * Since: 2.4