docs: Stop using the function tag

This commit is contained in:
Matthias Clasen 2014-02-01 12:19:04 -05:00
parent faa007c827
commit 77c4ff80dc
9 changed files with 40 additions and 42 deletions

View File

@ -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 <function>set()</function> call.
* but not an equivalent set() call.
*
* Signals are emitted on the action group in response to state changes
* on individual actions.

View File

@ -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 <function>g_static_rec_mutex_*</function> functions can
* be used even if g_thread_init() has not been called. Then they do
* nothing, apart from <function>g_static_rec_mutex_trylock</function>,
* 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:

View File

@ -90,7 +90,7 @@
*
* The GAsyncQueue struct is an opaque data structure which represents
* an asynchronous queue. It should only be accessed through the
* <function>g_async_queue_*</function> 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
* <function>g_async_queue_*_unlocked()</function> 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)

View File

@ -33,15 +33,16 @@
*
* These functions provide support for outputting messages.
*
* The <function>g_return</function> 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"

View File

@ -33,14 +33,14 @@
* @short_description: matches strings against patterns containing '*'
* (wildcard) and '?' (joker)
*
* The <function>g_pattern_match*</function> 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

View File

@ -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</ulink>.
*
* If you just need a random number, you simply call the
* <function>g_random_*</function> functions, which will create a
* globally used #GRand and use the according
* <function>g_rand_*</function> 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 <function>g_rand_*</function> 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.
* #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 <function>g_rand*_range</function> functions will return high
* quality equally distributed random numbers, whereas for example the
* The g_rand*_range functions will return high quality equally
* distributed random numbers, whereas for example the
* <literal>(g_random_int()&percnt;max)</literal> 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
* <function>g_rand*_int_range()</function> 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 <function>g_rand_*</function> 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 <function>g_random_*</function> functions, to @seed.
* by the g_random_* functions, to @seed.
**/
void
g_random_set_seed (guint32 seed)

View File

@ -44,7 +44,7 @@
* @short_description: matches strings against regular expressions
* @see_also: <xref linkend="glib-regex-syntax"/>
*
* The <function>g_regex_*()</function> functions implement regular
* The g_regex_*() functions implement regular
* expression pattern matching using syntax and semantics similar to
* Perl regular expression.
*

View File

@ -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 <function>g_private_</function> functions.
* be accessed via the g_private_ functions.
*/
/**

View File

@ -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 <function>g_mutex_</function>
* 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
* <function>g_rec_mutex_</function> functions.
* g_rec_mutex_ functions.
*
* Since: 2.32
*/