[glib] gstrfuncs: Fix up gtk-doc warnings
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] gstrfuncs: Fix up gtk-doc warnings
- Date: Sun, 2 Feb 2014 02:21:37 +0000 (UTC)
commit 26b4f6b41c40a6989af2c7a2da1f78d3e497a652
Author: Matthias Clasen <mclasen redhat com>
Date: Sat Feb 1 20:51:53 2014 -0500
gstrfuncs: Fix up gtk-doc warnings
glib/gstrfuncs.c | 42 +++++++++++++++++++++---------------------
glib/gstrfuncs.h | 3 +--
2 files changed, 22 insertions(+), 23 deletions(-)
---
diff --git a/glib/gstrfuncs.c b/glib/gstrfuncs.c
index aad8ab4..5482ab6 100644
--- a/glib/gstrfuncs.c
+++ b/glib/gstrfuncs.c
@@ -72,19 +72,19 @@
* <literal><glib/gprintf.h></literal> in order to use the GLib
* printf() functions.
*
- * <para id="string-precision">While you may use the printf() functions
- * to format UTF-8 strings, notice that the precision of a
- * <literal>%Ns</literal> parameter is interpreted as the
- * number of bytes, not characters to print. On top of that, the GNU
- * libc implementation of the printf() functions has the "feature" that
- * it checks that the string given for the <literal>%Ns</literal>
+ * <para id="string-precision">
+ * While you may use the printf() functions to format UTF-8 strings,
+ * notice that the precision of a %Ns parameter is interpreted
+ * as the number of bytes, not characters to print. On top of that,
+ * the GNU libc implementation of the printf() functions has the
+ * "feature" that it checks that the string given for the %Ns
* parameter consists of a whole number of characters in the current
* encoding. So, unless you are sure you are always going to be in an
* UTF-8 locale or your know your text is restricted to ASCII, avoid
- * using <literal>%Ns</literal>. If your intention is to format
- * strings for a certain number of columns, then
- * <literal>%Ns</literal> is not a correct solution anyway, since it
- * fails to take wide characters (see g_unichar_iswide()) into account.
+ * using %Ns. If your intention is to format strings for a
+ * certain number of columns, then %Ns is not a correct solution
+ * anyway, since it fails to take wide characters (see g_unichar_iswide())
+ * into account.
* </para>
*/
@@ -668,12 +668,12 @@ g_strtod (const gchar *nptr,
* To convert from a #gdouble to a string in a locale-insensitive
* way, use g_ascii_dtostr().
*
- * If the correct value would cause overflow, plus or minus <literal>HUGE_VAL</literal>
- * is returned (according to the sign of the value), and <literal>ERANGE</literal> is
- * stored in <literal>errno</literal>. If the correct value would cause underflow,
- * zero is returned and <literal>ERANGE</literal> is stored in <literal>errno</literal>.
+ * If the correct value would cause overflow, plus or minus %HUGE_VAL
+ * is returned (according to the sign of the value), and %ERANGE is
+ * stored in %errno. If the correct value would cause underflow,
+ * zero is returned and %ERANGE is stored in %errno.
*
- * This function resets <literal>errno</literal> before calling strtod() so that
+ * This function resets %errno before calling strtod() so that
* you can reliably detect overflow and underflow.
*
* Return value: the #gdouble value.
@@ -1506,22 +1506,22 @@ g_ascii_strup (const gchar *str,
/**
* g_str_is_ascii:
- * @string: a string
+ * @str: a string
*
- * Determines if a string is pure ASCII. A string is pure ASCII if it
+ * Determines if a string is pure ASCII. A string is pure ASCII if it
* contains no bytes with the high bit set.
*
- * Returns: %TRUE if @string is ascii
+ * Returns: %TRUE if @str is ASCII
*
* Since: 2.40
*/
gboolean
-g_str_is_ascii (const gchar *string)
+g_str_is_ascii (const gchar *str)
{
gint i;
- for (i = 0; string[i]; i++)
- if (string[i] & 0x80)
+ for (i = 0; str[i]; i++)
+ if (str[i] & 0x80)
return FALSE;
return TRUE;
diff --git a/glib/gstrfuncs.h b/glib/gstrfuncs.h
index ff513f2..0cf25a2 100644
--- a/glib/gstrfuncs.h
+++ b/glib/gstrfuncs.h
@@ -219,8 +219,7 @@ gchar* g_strdup_printf (const gchar *format,
...) G_GNUC_PRINTF (1, 2) G_GNUC_MALLOC;
GLIB_AVAILABLE_IN_ALL
gchar* g_strdup_vprintf (const gchar *format,
- va_list args) G_GNUC_PRINTF(1, 0)
- G_GNUC_MALLOC;
+ va_list args) G_GNUC_PRINTF(1, 0) G_GNUC_MALLOC;
GLIB_AVAILABLE_IN_ALL
gchar* g_strndup (const gchar *str,
gsize n) G_GNUC_MALLOC;
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]