get_Call_n_params: use int for consistency
[libfirm] / include / libfirm / irgwalk.h
index 33592ef..b0ab2f3 100644 (file)
  * @file
  * @brief    Traverse an ir graph
  * @author   Boris Boesler, Goetz Lindenmaier
- * @version  $Id$
- * @brief
- *  Traverse an ir graph:
- *  - execute the pre function before recursion
- *  - execute the post function after recursion
- *
- *  Uses current_ir_graph (from irgraph.h)!!! Set it to the proper
- *  graph before starting the walker.
  */
 #ifndef FIRM_IR_IRGWALK_H
 #define FIRM_IR_IRGWALK_H
 #include "firm_types.h"
 #include "begin.h"
 
+/**
+ * @ingroup ir_graph
+ * @defgroup irgwalk Traversing
+ *
+ *  Traverse graphs:
+ *  - execute the pre function before recursion
+ *  - execute the post function after recursion
+ * @{
+ */
+
 /**
  * Walks over the ir graph.
  *
@@ -137,9 +139,9 @@ FIRM_API void all_irg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
  * @param post  walker function, executed after the predecessor of a node are visited
  * @param env   environment, passed to pre and post
  *
- * This function Walks only over Block nodes in the graph. Has it's own visited
+ * This function Walks only over Block nodes in the graph. Has its own visited
  * flag, so that it can be interleaved with the other walker.
- * If a nonblock is passed, starts at the block this node belongs to.
+ * If a non-block is passed, starts at the block this node belongs to.
  * If end is passed also visits kept alive blocks. Does not use the link field.
  */
 FIRM_API void irg_block_walk(ir_node *node, irg_walk_func *pre,
@@ -252,6 +254,8 @@ FIRM_API void irg_walk_anchors(ir_graph *irg, irg_walk_func *pre,
 unsigned irg_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post,
                     void *env);
 
+/** @} */
+
 #include "end.h"
 
 #endif