luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-26 23:46:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

Documentation fixes

Browse Source
This commit is contained in:
Matthias Clasen 2011-10-02 23:43:17 -04:00
parent 65b84bb7d0
commit fa6710ab6f
4 changed files with 136 additions and 124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
docs/reference/glib/glib-sections.txt
View File

@ -584,23 +584,25 @@ G_THREAD_ERROR
GThreadError GThreadError
<SUBSECTION> <SUBSECTION>
GThreadFunctions
g_thread_init g_thread_init
g_thread_supported g_thread_supported
g_thread_get_initialized g_thread_get_initialized
<SUBSECTION> <SUBSECTION>
GThreadFunc GThreadFunc
GThreadPriority
GThread GThread
g_thread_create g_thread_new
g_thread_create_with_stack_size g_thread_new_full
g_thread_create_full
g_thread_self g_thread_self
g_thread_join g_thread_join
g_thread_set_priority
g_thread_yield g_thread_yield
g_thread_exit g_thread_exit
<SUBSECTION Deprecated>
g_thread_create
g_thread_create_full
GThreadPriority
g_thread_set_priority
g_thread_foreach g_thread_foreach
<SUBSECTION> <SUBSECTION>
@ -613,6 +615,14 @@ g_mutex_lock
g_mutex_trylock g_mutex_trylock
g_mutex_unlock g_mutex_unlock
<SUBSECTION>
G_LOCK_DEFINE
G_LOCK_DEFINE_STATIC
G_LOCK_EXTERN
G_LOCK
G_TRYLOCK
G_UNLOCK
<SUBSECTION> <SUBSECTION>
GRecMutex GRecMutex
g_rec_mutex_init g_rec_mutex_init
@ -632,47 +642,6 @@ g_rw_lock_reader_lock
g_rw_lock_reader_trylock g_rw_lock_reader_trylock
g_rw_lock_reader_unlock g_rw_lock_reader_unlock
<SUBSECTION>
GStaticMutex
G_STATIC_MUTEX_INIT
g_static_mutex_init
g_static_mutex_lock
g_static_mutex_trylock
g_static_mutex_unlock
g_static_mutex_get_mutex
g_static_mutex_free
<SUBSECTION>
G_LOCK_DEFINE
G_LOCK_DEFINE_STATIC
G_LOCK_EXTERN
G_LOCK
G_TRYLOCK
G_UNLOCK
<SUBSECTION>
GStaticRecMutex
G_STATIC_REC_MUTEX_INIT
g_static_rec_mutex_init
g_static_rec_mutex_lock
g_static_rec_mutex_trylock
g_static_rec_mutex_unlock
g_static_rec_mutex_lock_full
g_static_rec_mutex_unlock_full
g_static_rec_mutex_free
<SUBSECTION>
GStaticRWLock
G_STATIC_RW_LOCK_INIT
g_static_rw_lock_init
g_static_rw_lock_reader_lock
g_static_rw_lock_reader_trylock
g_static_rw_lock_reader_unlock
g_static_rw_lock_writer_lock
g_static_rw_lock_writer_trylock
g_static_rw_lock_writer_unlock
g_static_rw_lock_free
<SUBSECTION> <SUBSECTION>
GCond GCond
g_cond_new g_cond_new
@ -692,17 +661,9 @@ g_private_get
g_private_set g_private_set
g_private_replace g_private_replace
<SUBSECTION> <SUBSECTION Deprecated>
g_private_new g_private_new
<SUBSECTION>
GStaticPrivate
G_STATIC_PRIVATE_INIT
g_static_private_init
g_static_private_get
g_static_private_set
g_static_private_free
<SUBSECTION> <SUBSECTION>
GOnce GOnce
GOnceStatus GOnceStatus
@ -719,7 +680,49 @@ g_pointer_bit_lock
g_pointer_bit_trylock g_pointer_bit_trylock
g_pointer_bit_unlock g_pointer_bit_unlock
<SUBSECTION Deprecated>
GStaticMutex
G_STATIC_MUTEX_INIT
g_static_mutex_init
g_static_mutex_lock
g_static_mutex_trylock
g_static_mutex_unlock
g_static_mutex_get_mutex
g_static_mutex_free
<SUBSECTION Deprecated>
GStaticRecMutex
G_STATIC_REC_MUTEX_INIT
g_static_rec_mutex_init
g_static_rec_mutex_lock
g_static_rec_mutex_trylock
g_static_rec_mutex_unlock
g_static_rec_mutex_lock_full
g_static_rec_mutex_unlock_full
g_static_rec_mutex_free
<SUBSECTION Deprecated>
GStaticRWLock
G_STATIC_RW_LOCK_INIT
g_static_rw_lock_init
g_static_rw_lock_reader_lock
g_static_rw_lock_reader_trylock
g_static_rw_lock_reader_unlock
g_static_rw_lock_writer_lock
g_static_rw_lock_writer_trylock
g_static_rw_lock_writer_unlock
g_static_rw_lock_free
<SUBSECTION Deprecated>
GStaticPrivate
G_STATIC_PRIVATE_INIT
g_static_private_init
g_static_private_get
g_static_private_set
g_static_private_free
<SUBSECTION Private> <SUBSECTION Private>
GThreadFunctions
G_THREADS_ENABLED G_THREADS_ENABLED
g_static_mutex_get_mutex_impl g_static_mutex_get_mutex_impl
g_static_mutex_get_mutex_impl_shortcut g_static_mutex_get_mutex_impl_shortcut

9
glib/deprecated/gthread-deprecated.c
View File

@ -39,7 +39,7 @@
* @G_THREAD_PRIORITY_HIGH: a priority higher than normal * @G_THREAD_PRIORITY_HIGH: a priority higher than normal
* @G_THREAD_PRIORITY_URGENT: the highest priority * @G_THREAD_PRIORITY_URGENT: the highest priority
* *
* Deprecated:2.32: thread priorities no longer have any effect. * Deprecated:2.32: Thread priorities no longer have any effect.
*/ */
/** /**
@ -213,10 +213,9 @@ g_thread_create_full (GThreadFunc func,
* *
* Since: 2.10 * Since: 2.10
* *
* Deprecated:2.32: There are not very many interesting things you can * Deprecated:2.32: There aren't many things you can do with a #GThread,
* do with a #GThread, except comparing it with one that was returned * except comparing it with one that was returned from g_thread_create().
* from g_thread_create(). There are better ways to find out if your * There are better ways to find out if your thread is still alive.
* thread is still alive.
*/ */
void void
g_thread_foreach (GFunc thread_func, g_thread_foreach (GFunc thread_func,

3
glib/gthread-posix.c
View File

@ -1112,7 +1112,8 @@ g_system_thread_create (GThreadFunc thread_func,
/** /**
* g_thread_yield: * g_thread_yield:
* *
* Gives way to other threads waiting to be scheduled. * Causes the calling thread to voluntarily relinquish the CPU, so
* that other threads can run.
* *
* This function is often used as a method to make busy wait less evil. * This function is often used as a method to make busy wait less evil.
* But in most cases you will encounter, there are better methods to do * But in most cases you will encounter, there are better methods to do

133
glib/gthread.c
View File

@ -83,7 +83,7 @@
* individual bits for locks (g_bit_lock()). There are primitives * individual bits for locks (g_bit_lock()). There are primitives
* for condition variables to allow synchronization of threads (#GCond). * for condition variables to allow synchronization of threads (#GCond).
* There are primitives for thread-private data - data that every thread * There are primitives for thread-private data - data that every thread
* has a private instance of (#GPrivate, #GStaticPrivate). There are * has a private instance of (#GPrivate). There are
* facilities for one-time initialization (#GOnce, g_once_init_enter()). * facilities for one-time initialization (#GOnce, g_once_init_enter()).
* Finally there are primitives to create and manage threads (#GThread). * Finally there are primitives to create and manage threads (#GThread).
* *
@ -91,7 +91,7 @@
* You may call any other glib functions in the main thread before * You may call any other glib functions in the main thread before
* g_thread_init() as long as g_thread_init() is not called from * g_thread_init() as long as g_thread_init() is not called from
* a GLib callback, or with any locks held. However, many libraries * a GLib callback, or with any locks held. However, many libraries
* above GLib does not support late initialization of threads, so * above GLib do not support late initialization of threads, so
* doing this should be avoided if possible. * doing this should be avoided if possible.
* *
* Please note that since version 2.24 the GObject initialization * Please note that since version 2.24 the GObject initialization
@ -125,17 +125,15 @@
/** /**
* G_LOCK_DEFINE: * G_LOCK_DEFINE:
* @name: the name of the lock. * @name: the name of the lock
* *
* The %G_LOCK_* macros provide a convenient interface to #GMutex * The %G_LOCK_* macros provide a convenient interface to #GMutex.
* with the advantage that they will expand to nothing in programs * #G_LOCK_DEFINE defines a lock. It can appear in any place where
* compiled against a thread-disabled GLib, saving code and memory
* there. #G_LOCK_DEFINE defines a lock. It can appear anywhere
* variable definitions may appear in programs, i.e. in the first block * variable definitions may appear in programs, i.e. in the first block
* of a function or outside of functions. The @name parameter will be * of a function or outside of functions. The @name parameter will be
* mangled to get the name of the #GMutex. This means that you * mangled to get the name of the #GMutex. This means that you
* can use names of existing variables as the parameter - e.g. the name * can use names of existing variables as the parameter - e.g. the name
* of the variable you intent to protect with the lock. Look at our * of the variable you intend to protect with the lock. Look at our
* <function>give_me_next_number()</function> example using the * <function>give_me_next_number()</function> example using the
* %G_LOCK_* macros: * %G_LOCK_* macros:
* *
@ -162,14 +160,14 @@
/** /**
* G_LOCK_DEFINE_STATIC: * G_LOCK_DEFINE_STATIC:
* @name: the name of the lock. * @name: the name of the lock
* *
* This works like #G_LOCK_DEFINE, but it creates a static object. * This works like #G_LOCK_DEFINE, but it creates a static object.
*/ */
/** /**
* G_LOCK_EXTERN: * G_LOCK_EXTERN:
* @name: the name of the lock. * @name: the name of the lock
* *
* This declares a lock, that is defined with #G_LOCK_DEFINE in another * This declares a lock, that is defined with #G_LOCK_DEFINE in another
* module. * module.
@ -177,7 +175,7 @@
/** /**
* G_LOCK: * G_LOCK:
* @name: the name of the lock. * @name: the name of the lock
* *
* Works like g_mutex_lock(), but for a lock defined with * Works like g_mutex_lock(), but for a lock defined with
* #G_LOCK_DEFINE. * #G_LOCK_DEFINE.
@ -185,7 +183,7 @@
/** /**
* G_TRYLOCK: * G_TRYLOCK:
* @name: the name of the lock. * @name: the name of the lock
* @Returns: %TRUE, if the lock could be locked. * @Returns: %TRUE, if the lock could be locked.
* *
* Works like g_mutex_trylock(), but for a lock defined with * Works like g_mutex_trylock(), but for a lock defined with
@ -194,7 +192,7 @@
/** /**
* G_UNLOCK: * G_UNLOCK:
* @name: the name of the lock. * @name: the name of the lock
* *
* Works like g_mutex_unlock(), but for a lock defined with * Works like g_mutex_unlock(), but for a lock defined with
* #G_LOCK_DEFINE. * #G_LOCK_DEFINE.
@ -486,20 +484,24 @@
/** /**
* GThread: * GThread:
* *
* The #GThread struct represents a running thread. * The #GThread struct represents a running thread. This struct
* * is returned by g_thread_new() or g_thread_new_full(). You can
* Resources for a joinable thread are not fully released * obtain the #GThread struct representing the current thead by
* until g_thread_join() is called for that thread. * calling g_thread_self().
*/ */
/** /**
* GThreadFunc: * GThreadFunc:
* @data: data passed to the thread * @data: data passed to the thread
* @Returns: the return value of the thread, which will be returned by
* g_thread_join()
* *
* Specifies the type of the @func functions passed to * Specifies the type of the @func functions passed to
* g_thread_create() or g_thread_create_full(). * g_thread_new() or g_thread_new_full().
*
* If the thread is joinable, the return value of this function
* is returned by a g_thread_join() call waiting for the thread.
* If the thread is not joinable, the return value is ignored.
*
* Returns: the return value of the thread
*/ */
/** /**
@ -840,7 +842,7 @@ g_thread_create_proxy (gpointer data)
g_private_set (&g_thread_specific_private, data); g_private_set (&g_thread_specific_private, data);
/* The lock makes sure that thread->system_thread is written, /* The lock makes sure that thread->system_thread is written,
* before thread->thread.func is called. See g_thread_create(). * before thread->thread.func is called. See g_thread_new_internal().
*/ */
G_LOCK (g_thread_new); G_LOCK (g_thread_new);
G_UNLOCK (g_thread_new); G_UNLOCK (g_thread_new);
@ -858,23 +860,23 @@ g_thread_create_proxy (gpointer data)
* @joinable: should this thread be joinable? * @joinable: should this thread be joinable?
* @error: return location for error * @error: return location for error
* *
* This function creates a new thread. * This function creates a new thread. The new thread starts by
* invoking @func with the argument data. The thread will run
* until @func returns or until g_thread_exit() is called.
* *
* The @name can be useful for discriminating threads in * The @name can be useful for discriminating threads in
* a debugger. Some systems restrict the length of @name to * a debugger. Some systems restrict the length of @name to
* 16 bytes. * 16 bytes.
* *
* If @joinable is %TRUE, you can wait for this threads termination * If @joinable is %TRUE, you can wait for this threads termination
* calling g_thread_join(). Otherwise the thread will just disappear * calling g_thread_join(). Resources for a joinable thread are not
* when it terminates. * fully released until g_thread_join() is called for that thread.
* * Otherwise the thread will just disappear when it terminates.
* The new thread executes the function @func with the argument @data.
* If the thread was created successfully, it is returned.
* *
* @error can be %NULL to ignore errors, or non-%NULL to report errors. * @error can be %NULL to ignore errors, or non-%NULL to report errors.
* The error is set, if and only if the function returns %NULL. * The error is set, if and only if the function returns %NULL.
* *
* Returns: the new #GThread on success * Returns: the new #GThread, or %NULL if an error occurred
* *
* Since: 2.32 * Since: 2.32
*/ */
@ -897,7 +899,9 @@ g_thread_new (const gchar *name,
* @stack_size: a stack size for the new thread * @stack_size: a stack size for the new thread
* @error: return location for error * @error: return location for error
* *
* This function creates a new thread. * This function creates a new thread. The new thread starts by
* invoking @func with the argument data. The thread will run
* until @func returns or until g_thread_exit() is called.
* *
* The @name can be useful for discriminating threads in * The @name can be useful for discriminating threads in
* a debugger. Some systems restrict the length of @name to * a debugger. Some systems restrict the length of @name to
@ -905,24 +909,20 @@ g_thread_new (const gchar *name,
* *
* If the underlying thread implementation supports it, the thread * If the underlying thread implementation supports it, the thread
* gets a stack size of @stack_size or the default value for the * gets a stack size of @stack_size or the default value for the
* current platform, if @stack_size is 0. * current platform, if @stack_size is 0. Note that you should only
* use a non-zero @stack_size if you really can't use the default.
* In most cases, using g_thread_new() (which doesn't take a
* @stack_size) is better.
* *
* If @joinable is %TRUE, you can wait for this threads termination * If @joinable is %TRUE, you can wait for this threads termination
* calling g_thread_join(). Otherwise the thread will just disappear * calling g_thread_join(). Resources for a joinable thread are not
* when it terminates. * fully released until g_thread_join() is called for that thread.
* * Otherwise the thread will just disappear when it terminates.
* The new thread executes the function @func with the argument @data.
* If the thread was created successfully, it is returned.
* *
* @error can be %NULL to ignore errors, or non-%NULL to report errors. * @error can be %NULL to ignore errors, or non-%NULL to report errors.
* The error is set, if and only if the function returns %NULL. * The error is set, if and only if the function returns %NULL.
* *
* <note><para>Only use a non-zero @stack_size if you * Returns: the new #GThread, or %NULL if an error occurred
* really can't use the default instead. g_thread_new()
* does not take @stack_size, as it should only be used in cases
* in which it is unavoidable.</para></note>
*
* Returns: the new #GThread on success
* *
* Since: 2.32 * Since: 2.32
*/ */
@ -980,18 +980,15 @@ g_thread_new_internal (const gchar *name,
* g_thread_exit: * g_thread_exit:
* @retval: the return value of this thread * @retval: the return value of this thread
* *
* Exits the current thread. If another thread is waiting for that * Terminates the current thread.
* thread using g_thread_join() and the current thread is joinable, the
* waiting thread will be woken up and get @retval as the return value
* of g_thread_join(). If the current thread is not joinable, @retval
* is ignored. Calling
* *
* |[ * If another thread is waiting for that thread using g_thread_join()
* g_thread_exit (retval); * and the current thread is joinable, the waiting thread will be woken
* ]| * up and get @retval as the return value of g_thread_join(). If the
* current thread is not joinable, @retval is ignored.
* *
* is equivalent to returning @retval from the function @func, as given * Calling <literal>g_thread_exit (retval)</literal> is equivalent to
* to g_thread_create(). * returning @retval from the function @func, as given to g_thread_new().
* *
* <note><para>Never call g_thread_exit() from within a thread of a * <note><para>Never call g_thread_exit() from within a thread of a
* #GThreadPool, as that will mess up the bookkeeping and lead to funny * #GThreadPool, as that will mess up the bookkeeping and lead to funny
@ -1008,14 +1005,23 @@ g_thread_exit (gpointer retval)
/** /**
* g_thread_join: * g_thread_join:
* @thread: a #GThread to be waited for * @thread: a joinable #GThread
* *
* Waits until @thread finishes, i.e. the function @func, as given to * Waits until @thread finishes, i.e. the function @func, as
* g_thread_create(), returns or g_thread_exit() is called by @thread. * given to g_thread_new(), returns or g_thread_exit() is called.
* All resources of @thread including the #GThread struct are released. * If @thread has already terminated, then g_thread_join()
* @thread must have been created with @joinable=%TRUE in * returns immediately. @thread must be joinable.
* g_thread_create(). The value returned by @func or given to *
* g_thread_exit() by @thread is returned by this function. * Any thread can wait for any other (joinable) thread by calling
* g_thread_join(), not just its 'creator'. Calling g_thread_join()
* from multiple threads for the same @thread leads to undefined
* behaviour.
*
* The value returned by @func or given to g_thread_exit() is
* returned by this function.
*
* All resources of @thread including the #GThread struct are
* released before g_thread_join() returns.
* *
* Returns: the return value of the thread * Returns: the return value of the thread
*/ */
@ -1052,10 +1058,10 @@ g_thread_join (GThread *thread)
/** /**
* g_thread_self: * g_thread_self:
* *
* This functions returns the #GThread corresponding to the calling * This functions returns the #GThread corresponding to the
* thread. * current thread.
* *
* Returns: the current thread * Returns: the #GThread representing the current thread
*/ */
GThread* GThread*
g_thread_self (void) g_thread_self (void)
@ -1088,7 +1094,7 @@ g_thread_self (void)
/** /**
* g_mutex_new: * g_mutex_new:
* *
* Allocated and initializes a new #GMutex. * Allocates and initializes a new #GMutex.
* *
* Returns: a newly allocated #GMutex. Use g_mutex_free() to free * Returns: a newly allocated #GMutex. Use g_mutex_free() to free
*/ */
@ -1144,6 +1150,9 @@ g_cond_new (void)
* @cond: a #GCond * @cond: a #GCond
* *
* Destroys a #GCond that has been created with g_cond_new(). * Destroys a #GCond that has been created with g_cond_new().
*
* Calling g_cond_free() for a #GCond on which threads are
* blocking leads to undefined behaviour.
*/ */
void void
g_cond_free (GCond *cond) g_cond_free (GCond *cond)