X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fir%2Firgwalk.h;h=a40dcd8aa192a242a5b43d4feb95e7b039343873;hb=c3c48d7bd83f042cc2951754377de928d66fe51e;hp=8f44976ad847b38e08337406b05e5743c6a5b708;hpb=2f01596b117f89869d3cbb611f972ee1ddba4fa5;p=libfirm

diff --git a/ir/ir/irgwalk.h b/ir/ir/irgwalk.h
index 8f44976ad..a40dcd8aa 100644
--- a/ir/ir/irgwalk.h
+++ b/ir/ir/irgwalk.h
@@ -53,18 +53,20 @@ void finish_ip_walk(void);
 /**
  * Walks over the ir graph.
  *
- * @param node - the start node
- * @param pre  - walker function, executed before the predecessor of a node are visited
- * @param post - walker function, executed after the predecessor of a node are visited
- * @param env  - environment, passend to pre and post
- *
  * Walks over the ir graph, starting at the node given as first argument.
  * Executes pre before visiting the predecessor of a node, post after.
  * irg_walk uses the visited flag in irg and the nodes to determine visited
  * nodes.  It executes inc_irg_visited(current_ir_graph) to generate a new
- * flag.  It marks the node as visited before executing pre.
+ * flag.  Therefore current_ir_graph must be set before calling the walker.
+ * 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.  Does not use the link field.
+ *
+ * @param node - the start node
+ * @param pre  - walker function, executed before the predecessor of a node are visited
+ * @param post - walker function, executed after the predecessor of a node are visited
+ * @param env  - environment, passend to pre and post
+ *
  */
 void irg_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env);