From 77c4ff80dcf487d0a0f8b82e9c3e721618724bd0 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sat, 1 Feb 2014 12:19:04 -0500 Subject: [PATCH] docs: Stop using the function tag --- gio/gactiongroup.c | 2 +- glib/deprecated/gthread-deprecated.c | 10 +++++----- glib/gasyncqueue.c | 6 +++--- glib/gmessages.c | 19 ++++++++++--------- glib/gpattern.c | 6 +++--- glib/grand.c | 32 +++++++++++++++----------------- glib/gregex.c | 2 +- glib/gthread-posix.c | 2 +- glib/gthread.c | 5 ++--- 9 files changed, 41 insertions(+), 43 deletions(-) diff --git a/gio/gactiongroup.c b/gio/gactiongroup.c index 2fa0bd5..3426c74 100644 --- a/gio/gactiongroup.c +++ b/gio/gactiongroup.c @@ -64,7 +64,7 @@ * with actions. 'Internal' APIs (ie: ones meant only to be accessed by * the action group implementation) are found on subclasses. This is * why you will find - for example - g_action_group_get_action_enabled() - * but not an equivalent set() call. + * but not an equivalent set() call. * * Signals are emitted on the action group in response to state changes * on individual actions. diff --git a/glib/deprecated/gthread-deprecated.c b/glib/deprecated/gthread-deprecated.c index 6c38ee5..497657f 100644 --- a/glib/deprecated/gthread-deprecated.c +++ b/glib/deprecated/gthread-deprecated.c @@ -620,11 +620,11 @@ g_static_mutex_free (GStaticMutex* mutex) * Even though #GStaticRecMutex is not opaque, it should only be used * with the following functions. * - * All of the g_static_rec_mutex_* functions can - * be used even if g_thread_init() has not been called. Then they do - * nothing, apart from g_static_rec_mutex_trylock, - * which does nothing but returning %TRUE. - **/ + * All of the g_static_rec_mutex_* functions can be used even if + * g_thread_init() has not been called. Then they do nothing, apart + * from g_static_rec_mutex_trylock(), which does nothing but returning + * %TRUE. + */ /** * G_STATIC_REC_MUTEX_INIT: diff --git a/glib/gasyncqueue.c b/glib/gasyncqueue.c index 6aa7611..40ce372 100644 --- a/glib/gasyncqueue.c +++ b/glib/gasyncqueue.c @@ -90,7 +90,7 @@ * * The GAsyncQueue struct is an opaque data structure which represents * an asynchronous queue. It should only be accessed through the - * g_async_queue_* functions. + * g_async_queue_* functions. */ struct _GAsyncQueue { @@ -247,8 +247,8 @@ g_async_queue_unref (GAsyncQueue *queue) * Call g_async_queue_unlock() to drop the lock again. * * While holding the lock, you can only call the - * g_async_queue_*_unlocked() functions - * on @queue. Otherwise, deadlock may occur. + * g_async_queue_*_unlocked() functions on @queue. Otherwise, + * deadlock may occur. */ void g_async_queue_lock (GAsyncQueue *queue) diff --git a/glib/gmessages.c b/glib/gmessages.c index 4fdc5ff..b1dc708 100644 --- a/glib/gmessages.c +++ b/glib/gmessages.c @@ -33,15 +33,16 @@ * * These functions provide support for outputting messages. * - * The g_return family of macros (g_return_if_fail(), - * g_return_val_if_fail(), g_return_if_reached(), g_return_val_if_reached()) - * should only be used for programming errors, a typical use case is - * checking for invalid parameters at the beginning of a public function. - * They should not be used if you just mean "if (error) return", they - * should only be used if you mean "if (bug in program) return". - * The program behavior is generally considered undefined after one - * of these checks fails. They are not intended for normal control - * flow, only to give a perhaps-helpful warning before giving up. + * The g_return() family of macros (g_return_if_fail(), + * g_return_val_if_fail(), g_return_if_reached(), + * g_return_val_if_reached()) should only be used for programming + * errors, a typical use case is checking for invalid parameters at + * the beginning of a public function. They should not be used if + * you just mean "if (error) return", they should only be used if + * you mean "if (bug in program) return". The program behavior is + * generally considered undefined after one of these checks fails. + * They are not intended for normal control flow, only to give a + * perhaps-helpful warning before giving up. */ #include "config.h" diff --git a/glib/gpattern.c b/glib/gpattern.c index 4894c28..b74f36c 100644 --- a/glib/gpattern.c +++ b/glib/gpattern.c @@ -33,14 +33,14 @@ * @short_description: matches strings against patterns containing '*' * (wildcard) and '?' (joker) * - * The g_pattern_match* functions match a string + * The g_pattern_match* functions match a string * against a pattern containing '*' and '?' wildcards with similar * semantics as the standard glob() function: '*' matches an arbitrary, * possibly empty, string, '?' matches an arbitrary character. * * Note that in contrast to glob(), the '/' character can be matched by - * the wildcards, there are no '[...]' character ranges and '*' and '?' can - * not be escaped to include them literally in a pattern. + * the wildcards, there are no '[...]' character ranges and '*' and '?' + * can not be escaped to include them literally in a pattern. * * When multiple strings must be matched against the same pattern, it * is better to compile the pattern to a #GPatternSpec using diff --git a/glib/grand.c b/glib/grand.c index 1ade68d..018c620 100644 --- a/glib/grand.c +++ b/glib/grand.c @@ -82,28 +82,26 @@ * url="http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html"> * http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html. * - * If you just need a random number, you simply call the - * g_random_* functions, which will create a - * globally used #GRand and use the according - * g_rand_* functions internally. Whenever you + * If you just need a random number, you simply call the g_random_* + * functions, which will create a globally used #GRand and use the + * according g_rand_* functions internally. Whenever you * need a stream of reproducible random numbers, you better create a - * #GRand yourself and use the g_rand_* functions - * directly, which will also be slightly faster. Initializing a #GRand - * with a certain seed will produce exactly the same series of random - * numbers on all platforms. This can thus be used as a seed for e.g. - * games. - * - * The g_rand*_range functions will return high - * quality equally distributed random numbers, whereas for example the + * #GRand yourself and use the g_rand_* functions directly, which will + * also be slightly faster. Initializing a #GRand with a certain seed + * will produce exactly the same series of random numbers on all + * platforms. This can thus be used as a seed for e.g. games. + * + * The g_rand*_range functions will return high quality equally + * distributed random numbers, whereas for example the * (g_random_int()%max) approach often * doesn't yield equally distributed numbers. * * GLib changed the seeding algorithm for the pseudo-random number * generator Mersenne Twister, as used by #GRand and #GRandom. * This was necessary, because some seeds would yield very bad - * pseudo-random streams. Also the pseudo-random integers generated by - * g_rand*_int_range() will have a slightly better - * equal distribution with the new version of GLib. + * pseudo-random streams. Also the pseudo-random integers generated + * by g_rand*_int_range() will have a slightly better equal + * distribution with the new version of GLib. * * The original seeding and generation algorithms, as found in GLib * 2.0.x, can be used instead of the new ones by setting the @@ -116,7 +114,7 @@ * GRand: * * The #GRand struct is an opaque data structure. It should only be - * accessed through the g_rand_* functions. + * accessed through the g_rand_* functions. **/ G_LOCK_DEFINE_STATIC (global_random); @@ -691,7 +689,7 @@ g_random_double_range (gdouble begin, gdouble end) * @seed: a value to reinitialize the global random number generator. * * Sets the seed for the global random number generator, which is used - * by the g_random_* functions, to @seed. + * by the g_random_* functions, to @seed. **/ void g_random_set_seed (guint32 seed) diff --git a/glib/gregex.c b/glib/gregex.c index 01d3019..393637f 100644 --- a/glib/gregex.c +++ b/glib/gregex.c @@ -44,7 +44,7 @@ * @short_description: matches strings against regular expressions * @see_also: * - * The g_regex_*() functions implement regular + * The g_regex_*() functions implement regular * expression pattern matching using syntax and semantics similar to * Perl regular expression. * diff --git a/glib/gthread-posix.c b/glib/gthread-posix.c index 5c559fd..ee6d81b 100644 --- a/glib/gthread-posix.c +++ b/glib/gthread-posix.c @@ -895,7 +895,7 @@ g_cond_wait_until (GCond *cond, * See G_PRIVATE_INIT() for a couple of examples. * * The #GPrivate structure should be considered opaque. It should only - * be accessed via the g_private_ functions. + * be accessed via the g_private_ functions. */ /** diff --git a/glib/gthread.c b/glib/gthread.c index 8844146..3bc2f17 100644 --- a/glib/gthread.c +++ b/glib/gthread.c @@ -266,8 +266,7 @@ * If a #GMutex is placed in other contexts (eg: embedded in a struct) * then it must be explicitly initialised using g_mutex_init(). * - * A #GMutex should only be accessed via g_mutex_ - * functions. + * A #GMutex should only be accessed via g_mutex_ functions. */ /* GRecMutex Documentation {{{1 -------------------------------------- */ @@ -286,7 +285,7 @@ * g_rec_mutex_init() on it and g_rec_mutex_clear() when done. * * A GRecMutex should only be accessed with the - * g_rec_mutex_ functions. + * g_rec_mutex_ functions. * * Since: 2.32 */ -- 2.7.4