some fixes for xml dumper / still buggy.

[libfirm] / ir / ir / irgwalk.h

diff --git a/ir/ir/irgwalk.h b/ir/ir/irgwalk.h
index bd55265..9b2c03a 100644 (file)
--- a/ir/ir/irgwalk.h
+++ b/ir/ir/irgwalk.h
@@ -28,7 +28,7 @@
 #ifndef _IRG_WALK_FUNC_TYPEDEF_
 #define _IRG_WALK_FUNC_TYPEDEF_
 /**
- * The type of a walk function.
+ * The type of a walk function.  Does not use the link field.
  *
  * @param node - the node that is just visited
  * @param env  - an environment pointer passed by the walk functions
@@ -56,7 +56,7 @@ void finish_ip_walk(void);
  * nodes.  It executes inc_irg_visited(current_ir_graph) to generate a new
  * flag.  It marks the node as visited before executing pre.
  * The void* env can be used to pass status information between the
- * pre and post functions.
+ * pre and post functions.  Does not use the link field.
  */
 void irg_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env);
 
@@ -70,7 +70,7 @@ void irg_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env)
  *
  * Like irg_walk(), but walks over all reachable nodes in the ir
  * graph, starting at the end operation. During the walk current_ir_graph
- * is set to irg.
+ * is set to irg.  Does not use the link field.
  */
 void irg_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env);
 
@@ -84,7 +84,7 @@ void irg_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void
  * This function executes irg_walk(end, pre, post, env) for all irgraphs in irprog.
  * Sets current_ir_graph properly for each walk.  Conserves current
  * current_ir_graph.  In interprocedural view nodes can be visited several
- * times.
+ * times.  Does not use the link field.
  */
 void all_irg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
 
@@ -96,7 +96,7 @@ void all_irg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
  * @param env  - environment, passend to pre and post
  *
  * This function walks all irgs in interprocedural view.
- * Visits each node only once.Sets current_ir_graph properly.
+ * Visits each node only once.  Sets current_ir_graph properly. Does not use the link field.
  */
 void cg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
 
@@ -111,7 +111,7 @@ void cg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
  * This function Walks only over Block nodes in the graph. Has it's own visited
  * flag, so that it can be interleaved with the other walker.
  * If a none block is passed, starts at the block this node belongs to.
- * If end is passed also visites kept alive blocks.
+ * If end is passed also visites kept alive blocks. Does not use the link field.
  */
 void irg_block_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env);
 
@@ -124,7 +124,7 @@ void irg_block_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void
  * @param env  - environment, passend to pre and post
  *
  * Like irg_block_walk(), but walks over all reachable blocks in the
- * ir graph, starting at the end block.
+ * ir graph, starting at the end block. Does not use the link field.
  */
 void irg_block_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env);
 
@@ -136,7 +136,7 @@ void irg_block_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post
  * @param env  - environment, passend to pre and post
  *
  * This function walks over all code in const_code_irg.
- * Uses visited flag in const_code_irg.
+ * Uses visited flag in const_code_irg.  Does not use the link field.
  */
 void walk_const_code(irg_walk_func *pre, irg_walk_func *post, void *env);