beifg: Remove the unused function be_ifg_nodes_break().

[libfirm] / include / libfirm / irgwalk.h

diff --git a/include/libfirm/irgwalk.h b/include/libfirm/irgwalk.h
index 33592ef..72679a0 100644 (file)
--- a/include/libfirm/irgwalk.h
+++ b/include/libfirm/irgwalk.h
@@ -1,34 +1,12 @@
 /*
- * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
- *
  * This file is part of libFirm.
- *
- * This file may be distributed and/or modified under the terms of the
- * GNU General Public License version 2 as published by the Free Software
- * Foundation and appearing in the file LICENSE.GPL included in the
- * packaging of this file.
- *
- * Licensees holding valid libFirm Professional Edition licenses may use
- * this file in accordance with the libFirm Commercial License.
- * Agreement provided with the Software.
- *
- * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
- * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE.
+ * Copyright (C) 2012 University of Karlsruhe.
  */
 
 /**
  * @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
@@ -36,6 +14,16 @@
 #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 +125,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 none block 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,
@@ -249,8 +237,10 @@ FIRM_API void irg_walk_anchors(ir_graph *irg, irg_walk_func *pre,
  * Walker function which does not increase the visited flag before walking.
  * Do not use this unless you know what you are doing.
  */
-unsigned irg_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post,
-                    void *env);
+FIRM_API void irg_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post,
+                         void *env);
+
+/** @} */
 
 #include "end.h"