mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-08-01 23:13:40 +02:00
Documentation fixes.
* glib/gconvert.c, glib/grand.c, glib/ghash.c, glib/gthreadpool.c, glib/gtree.c: Documentation fixes. * glib/tmpl/allocators.sgml, glib/tmpl/arrays.sgml, glib/tmpl/arrays_byte.sgml, glib/tmpl/arrays_pointer.sgml, glib/tmpl/caches.sgml, glib/tmpl/completion.sgml, glib/tmpl/conversions.sgml, glib/tmpl/datalist.sgml, glib/tmpl/date.sgml, glib/tmpl/error_reporting.sgml, glib/tmpl/fileutils.sgml, glib/tmpl/hash_tables.sgml, glib/tmpl/hooks.sgml, glib/tmpl/macros.sgml, glib/tmpl/macros_misc.sgml, glib/tmpl/main.sgml, glib/tmpl/markup.sgml, glib/tmpl/memory.sgml, glib/tmpl/memory_chunks.sgml, glib/tmpl/messages.sgml, glib/tmpl/misc_utils.sgml, glib/tmpl/modules.sgml, glib/tmpl/numerical.sgml, glib/tmpl/patterns.sgml, glib/tmpl/queue.sgml, glib/tmpl/shell.sgml, glib/tmpl/spawn.sgml, glib/tmpl/string_utils.sgml, glib/tmpl/thread_pools.sgml, glib/tmpl/threads.sgml, glib/tmpl/timers.sgml, glib/tmpl/trees-binary.sgml, glib/tmpl/trees-nary.sgml, glib/tmpl/type_conversion.sgml, glib/tmpl/unicode.sgml, glib/tmpl/warnings.sgml, glib/tmpl/windows.sgml: Improve markup of examples, general consistency improvements.
This commit is contained in:
14
glib/gtree.c
14
glib/gtree.c
@@ -278,7 +278,7 @@ g_tree_destroy (GTree *tree)
|
||||
* Inserts a key/value pair into a #GTree. If the given key already exists
|
||||
* in the #GTree its corresponding value is set to the new value. If you
|
||||
* supplied a value_destroy_func when creating the #GTree, the old value is
|
||||
* freed using that function. If you supplied a key_destroy_func when
|
||||
* freed using that function. If you supplied a @key_destroy_func when
|
||||
* creating the #GTree, the passed key is freed using that function.
|
||||
*
|
||||
* The tree is automatically 'balanced' as new key/value pairs are added,
|
||||
@@ -308,9 +308,9 @@ g_tree_insert (GTree *tree,
|
||||
*
|
||||
* Inserts a new key and value into a #GTree similar to g_tree_insert().
|
||||
* The difference is that if the key already exists in the #GTree, it gets
|
||||
* replaced by the new key. If you supplied a value_destroy_func when
|
||||
* replaced by the new key. If you supplied a @value_destroy_func when
|
||||
* creating the #GTree, the old value is freed using that function. If you
|
||||
* supplied a key_destroy_func when creating the #GTree, the old key is
|
||||
* supplied a @key_destroy_func when creating the #GTree, the old key is
|
||||
* freed using that function.
|
||||
*
|
||||
* The tree is automatically 'balanced' as new key/value pairs are added,
|
||||
@@ -340,7 +340,7 @@ g_tree_replace (GTree *tree,
|
||||
* Removes a key/value pair from a #GTree.
|
||||
*
|
||||
* If the #GTree was created using g_tree_new_full(), the key and value
|
||||
* are freed using the supplied destroy_functions, otherwise you have to
|
||||
* are freed using the supplied @destroy_functions, otherwise you have to
|
||||
* make sure that any dynamically allocated values are freed yourself.
|
||||
**/
|
||||
void
|
||||
@@ -402,11 +402,11 @@ g_tree_lookup (GTree *tree,
|
||||
* @value: returns the value associated with the key.
|
||||
*
|
||||
* Looks up a key in the #GTree, returning the original key and the
|
||||
* associated value and a gboolean which is TRUE if the key was found. This
|
||||
* associated value and a #gboolean which is %TRUE if the key was found. This
|
||||
* is useful if you need to free the memory allocated for the original key,
|
||||
* for example before calling g_tree_remove().
|
||||
*
|
||||
* Return value: #TRUE if the key was found in the #GTree.
|
||||
* Return value: %TRUE if the key was found in the #GTree.
|
||||
**/
|
||||
gboolean
|
||||
g_tree_lookup_extended (GTree *tree,
|
||||
@@ -527,7 +527,7 @@ g_tree_traverse (GTree *tree,
|
||||
* To search for a specific value, you can use g_tree_foreach() or
|
||||
* g_tree_traverse().
|
||||
*
|
||||
* Return value: the value corresponding to the found key, or NULL if the key
|
||||
* Return value: the value corresponding to the found key, or %NULL if the key
|
||||
* is not found.
|
||||
**/
|
||||
gpointer
|
||||
|
Reference in New Issue
Block a user