From 3b25e975b3272f73e9e3d61ffd67ce89b6edfc8a Mon Sep 17 00:00:00 2001 From: Ryan Lortie Date: Mon, 5 Sep 2011 11:30:58 -0400 Subject: [PATCH] gtk-doc fixups for glib/ --- docs/reference/glib/tmpl/date.sgml | 2 +- glib/gbookmarkfile.c | 4 +- glib/gdatetime.c | 100 ++++++++++++++--------------- glib/glib-unix.c | 2 +- glib/glib-unix.h | 10 +-- glib/gmain.c | 2 +- glib/gtestutils.c | 2 +- glib/gunicode.h | 4 +- glib/guniprop.c | 2 +- 9 files changed, 64 insertions(+), 64 deletions(-) diff --git a/docs/reference/glib/tmpl/date.sgml b/docs/reference/glib/tmpl/date.sgml index 830a29985..4659d4c23 100644 --- a/docs/reference/glib/tmpl/date.sgml +++ b/docs/reference/glib/tmpl/date.sgml @@ -714,7 +714,7 @@ string and stores a UTF-8 result. This function does not provide any conversion specifiers in addition to those implemented by the platform's C library. For example, don't -expect that using g_date_strftime() would make the %F provided by the C99 +expect that using g_date_strftime() would make the \%F provided by the C99 strftime() work on Windows where the C library only complies to C89. diff --git a/glib/gbookmarkfile.c b/glib/gbookmarkfile.c index db2a8bcb1..b1fb0b917 100644 --- a/glib/gbookmarkfile.c +++ b/glib/gbookmarkfile.c @@ -3208,9 +3208,9 @@ g_bookmark_file_has_application (GBookmarkFile *bookmark, * * @name can be any UTF-8 encoded string used to identify an * application. - * @exec can have one of these two modifiers: "%f", which will + * @exec can have one of these two modifiers: "\%f", which will * be expanded as the local file name retrieved from the bookmark's - * URI; "%u", which will be expanded as the bookmark's URI. + * URI; "\%u", which will be expanded as the bookmark's URI. * The expansion is done automatically when retrieving the stored * command line using the g_bookmark_file_get_app_info() function. * @count is the number of times the application has registered the diff --git a/glib/gdatetime.c b/glib/gdatetime.c index c3dd6b710..3a3557c92 100644 --- a/glib/gdatetime.c +++ b/glib/gdatetime.c @@ -2146,9 +2146,9 @@ format_number (GString *str, * Creates a newly allocated string representing the requested @format. * * The format strings understood by this function are a subset of the - * strftime() format language as specified by C99. The %%D, %%U and %%W + * strftime() format language as specified by C99. The \%D, \%U and \%W * conversions are not supported, nor is the 'E' modifier. The GNU - * extensions %%k, %%l, %%s and %%P are supported, however, as are the + * extensions \%k, \%l, \%s and \%P are supported, however, as are the * '0', '_' and '-' modifiers. * * In contrast to strftime(), this function always produces a UTF-8 @@ -2160,207 +2160,207 @@ format_number (GString *str, * * * - * %%a: + * \%a: * * the abbreviated weekday name according to the current locale * * - * %%A: + * \%A: * * the full weekday name according to the current locale * * - * %%b: + * \%b: * * the abbreviated month name according to the current locale * * - * %%B: + * \%B: * * the full month name according to the current locale * * - * %%c: + * \%c: * * the preferred date and time representation for the current locale * * - * %%C: + * \%C: * * The century number (year/100) as a 2-digit integer (00-99) * * - * %%d: + * \%d: * * the day of the month as a decimal number (range 01 to 31) * * - * %%e: + * \%e: * * the day of the month as a decimal number (range 1 to 31) * * - * %%F: + * \%F: * - * equivalent to %%Y-%%m-%%d (the ISO 8601 date + * equivalent to \%Y-\%m-\%d (the ISO 8601 date * format) * * - * %%g: + * \%g: * * the last two digits of the ISO 8601 week-based year as a decimal - * number (00-99). This works well with %%V and %%u. + * number (00-99). This works well with \%V and \%u. * * - * %%G: + * \%G: * * the ISO 8601 week-based year as a decimal number. This works well - * with %%V and %%u. + * with \%V and \%u. * * - * %%h: + * \%h: * - * equivalent to %%b + * equivalent to \%b * * - * %%H: + * \%H: * * the hour as a decimal number using a 24-hour clock (range 00 to * 23) * * - * %%I: + * \%I: * * the hour as a decimal number using a 12-hour clock (range 01 to * 12) * * - * %%j: + * \%j: * * the day of the year as a decimal number (range 001 to 366) * * - * %%k: + * \%k: * * the hour (24-hour clock) as a decimal number (range 0 to 23); * single digits are preceded by a blank * * - * %%l: + * \%l: * * the hour (12-hour clock) as a decimal number (range 1 to 12); * single digits are preceded by a blank * * - * %%m: + * \%m: * * the month as a decimal number (range 01 to 12) * * - * %%M: + * \%M: * * the minute as a decimal number (range 00 to 59) * * - * %%p: + * \%p: * * either "AM" or "PM" according to the given time value, or the * corresponding strings for the current locale. Noon is treated as * "PM" and midnight as "AM". * * - * %%P: + * \%P: * - * like %%p but lowercase: "am" or "pm" or a corresponding string for + * like \%p but lowercase: "am" or "pm" or a corresponding string for * the current locale * * - * %%r: + * \%r: * * the time in a.m. or p.m. notation * * - * %%R: + * \%R: * - * the time in 24-hour notation (%%H:%%M) + * the time in 24-hour notation (\%H:\%M) * * - * %%s: + * \%s: * * the number of seconds since the Epoch, that is, since 1970-01-01 * 00:00:00 UTC * * - * %%S: + * \%S: * * the second as a decimal number (range 00 to 60) * * - * %%t: + * \%t: * * a tab character * * - * %%T: + * \%T: * - * the time in 24-hour notation with seconds (%%H:%%M:%%S) + * the time in 24-hour notation with seconds (\%H:\%M:\%S) * * - * %%u: + * \%u: * * the ISO 8601 standard day of the week as a decimal, range 1 to 7, - * Monday being 1. This works well with %%G and %%V. + * Monday being 1. This works well with \%G and \%V. * * - * %%V: + * \%V: * * the ISO 8601 standard week number of the current year as a decimal * number, range 01 to 53, where week 1 is the first week that has at * least 4 days in the new year. See g_date_time_get_week_of_year(). - * This works well with %%G and %%u. + * This works well with \%G and \%u. * * - * %%w: + * \%w: * * the day of the week as a decimal, range 0 to 6, Sunday being 0. - * This is not the ISO 8601 standard format -- use %%u instead. + * This is not the ISO 8601 standard format -- use \%u instead. * * - * %%x: + * \%x: * * the preferred date representation for the current locale without * the time * * - * %%X: + * \%X: * * the preferred time representation for the current locale without * the date * * - * %%y: + * \%y: * * the year as a decimal number without the century * * - * %%Y: + * \%Y: * * the year as a decimal number including the century * * - * %%z: + * \%z: * * the time-zone as hour offset from UTC * * - * %%Z: + * \%Z: * * the time zone or name or abbreviation * * - * %%%: + * \%\%: * - * a literal %% character + * a literal \% character * * * diff --git a/glib/glib-unix.c b/glib/glib-unix.c index 6b5495b0d..2654f0e5d 100644 --- a/glib/glib-unix.c +++ b/glib/glib-unix.c @@ -262,7 +262,7 @@ g_unix_signal_add_full (int priority, } /** - * g_unix_signal_add_full: + * g_unix_signal_add: * @signum: Signal number * @handler: Callback * @user_data: Data for @handler diff --git a/glib/glib-unix.h b/glib/glib-unix.h index 32c6c808c..9642b5c8e 100644 --- a/glib/glib-unix.h +++ b/glib/glib-unix.h @@ -40,12 +40,12 @@ /** * G_UNIX_ERROR: - * - * Error domain for API in the "g_unix_" namespace. Note that there - * is no exported enumeration mapping %errno. Instead, all functions + * + * Error domain for API in the "g_unix_" namespace. Note that there is + * no exported enumeration mapping %errno. Instead, all functions * ensure that %errno is relevant. The code for all #G_UNIX_ERROR is - * always %0, and the error message is always generated via - * g_strerror(). + * always 0, and the error message is always + * generated via g_strerror(). * * It is expected that most code will not look at %errno from these * APIs. Important cases where one would want to differentiate between diff --git a/glib/gmain.c b/glib/gmain.c index d8d629271..6662a093c 100644 --- a/glib/gmain.c +++ b/glib/gmain.c @@ -3788,7 +3788,7 @@ g_main_context_wakeup (GMainContext *context) * @context: a #GMainContext * * Determines whether this thread holds the (recursive) - * ownership of this #GMaincontext. This is useful to + * ownership of this #GMainContext. This is useful to * know before waiting on another thread that may be * blocking to get ownership of @context. * diff --git a/glib/gtestutils.c b/glib/gtestutils.c index 00bad2b7c..37933de78 100644 --- a/glib/gtestutils.c +++ b/glib/gtestutils.c @@ -801,7 +801,7 @@ g_test_message (const char *format, * case only. * Bug URIs are constructed by appending a bug specific URI * portion to @uri_pattern, or by replacing the special string - * '%s' within @uri_pattern if that is present. + * '\%s' within @uri_pattern if that is present. * * Since: 2.16 */ diff --git a/glib/gunicode.h b/glib/gunicode.h index ad2f638be..5d5d3ad74 100644 --- a/glib/gunicode.h +++ b/glib/gunicode.h @@ -49,8 +49,8 @@ G_BEGIN_DECLS * letters, prefixed by the string "U+". Leading zeros are omitted, * unless the code point would have fewer than four hexadecimal digits. * For example, "U+0041 LATIN CAPITAL LETTER A". To print a code point - * in the U+-notation, use the format string "U+%04"G_GINT32_FORMAT"X". - * To scan, use the format string "U+%06"G_GINT32_FORMAT"X". + * in the U+-notation, use the format string "U+\%04"G_GINT32_FORMAT"X". + * To scan, use the format string "U+\%06"G_GINT32_FORMAT"X". * * |[ * gunichar c; diff --git a/glib/guniprop.c b/glib/guniprop.c index 55170d44d..2879a8096 100644 --- a/glib/guniprop.c +++ b/glib/guniprop.c @@ -1297,7 +1297,7 @@ g_unichar_get_script_bsearch (gunichar ch) * @ch: a Unicode character * * Looks up the #GUnicodeScript for a particular character (as defined - * by Unicode Standard Annex #24). No check is made for @ch being a + * by Unicode Standard Annex \#24). No check is made for @ch being a * valid Unicode character; if you pass in invalid character, the * result is undefined. *