# HG changeset patch # User Mike Becker # Date 1743717571 -7200 # Node ID e9c0ad32768410d55f8be4de4a4c91ea55ceab18 # Parent 503f0ad94c6cb9eff0e884c8be781293bea05e38 add iterator / visitor docu relates to #451 diff -r 503f0ad94c6c -r e9c0ad327684 docs/Writerside/topics/tree.h.md --- a/docs/Writerside/topics/tree.h.md Wed Apr 02 20:25:50 2025 +0200 +++ b/docs/Writerside/topics/tree.h.md Thu Apr 03 23:59:31 2025 +0200 @@ -296,9 +296,19 @@ void cxTreeVisitorDispose(CxTreeVisitor *visitor); ``` - -TODO: document - +There are two different kind of iterators for trees. +The `CxTreeIterator` is performing a depth-first iteration with the capability of visiting a node twice: +first when the iterator enters the node coming from its parent, and secondly when the iterator tracks back from its last child. +On the other hand, the `CxTreeVisitor` performs a breadth-first iteration and visits every node only once. + +Since tree iteration needs to keep track of a stack (depth-first) or queue (breadth-frist), internal memory is allocated. +This memory is _automatically_ disposed when the iteration _completes_. +If you break from the iteration early, you must call `cxTreeIteratorDispose()` or `cxTreeVisitorDispose()`, respectively, to deallocate the memory. + +> It is strongly recommended to always invoke the dispose functions, even when it seems not necessary. +> In the best case it just does nothing, but calling them guarantees that no memory can be leaking. +>{style="note"} + ## Remove