luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 06:56:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document G_LEVEL_ORDER better.

Browse Source 
* glib/tmpl/trees-binary.sgml: Document G_LEVEL_ORDER better.
This commit is contained in:
Matthias Clasen 2001-11-27 22:16:54 +00:00
parent 8049ab4876
commit 1d5e8cbc7d
2 changed files with 11 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/ChangeLog
View File

@ -1,6 +1,6 @@
2001-11-26 Matthias Clasen <matthiasc@poet.de>
* glib/tmpl/trees-nary.sgml: Document G_LEVEL_ORDER better.
* glib/tmpl/trees-binary.sgml: Document G_LEVEL_ORDER better.
2001-11-22 Matthias Clasen <matthiasc@poet.de>

36
docs/reference/glib/tmpl/trees-binary.sgml
View File

@ -176,32 +176,18 @@ If the function returns %TRUE, the traversal is stopped.
<para>
Specifies the type of traveral performed by g_tree_traverse(),
g_node_traverse() and g_node_find().
<itemizedlist>
<listitem><para>
%G_PRE_ORDER visits a node, then its children.
</para></listitem>
<listitem><para>
%G_IN_ORDER vists a node's left child first, then the node itself, then its
right child. This is the one to use if you want the output sorted according
to the compare function.
</para></listitem>
<listitem><para>
%G_POST_ORDER visits the node's children, then the node itself.
</para></listitem>
<listitem><para>
%G_LEVEL_ORDER is not implemented for
<link linkend="glib-Balanced-Binary-Trees">Balanced Binary Trees</link>.
For <link linkend="glib-N-ary-Trees">N-ary Trees</link>
it calls the function for each child of the node, then it recursively visits
each child.
</para></listitem>
</itemizedlist>
</para>
@G_IN_ORDER:
@G_PRE_ORDER:
@G_POST_ORDER:
@G_LEVEL_ORDER:
@G_PRE_ORDER: visits a node, then its children.
@G_IN_ORDER: vists a node's left child first, then the node itself, then its
right child. This is the one to use if you want the output sorted according
to the compare function.
@G_POST_ORDER: visits the node's children, then the node itself.
@G_LEVEL_ORDER: is not implemented for
<link linkend="glib-Balanced-Binary-Trees">Balanced Binary Trees</link>.
For <link linkend="glib-N-ary-Trees">N-ary Trees</link>, it vists the root
node first, then its children, then its grandchildren, and so on. Note that
this is less efficient than the other orders.
<!-- ##### FUNCTION g_tree_search ##### -->
<para>
@ -212,8 +198,6 @@ each child.
@search_func:
@user_data:
@Returns:
<!-- # Unused Parameters # -->
@data:
<!-- ##### FUNCTION g_tree_remove ##### -->