X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fir%2Firgmod.h;h=f3f77fe885b0dc6094d45f7cdbd4055f4e8fea37;hb=23ea16875f38dc0c067cce24f64b5c70f3acc496;hp=13bada4f2468b858e1091de9d528a9bf26413360;hpb=c2b4a9f3d77fda7989e9cbd6293b9f9f58f4221c;p=libfirm

diff --git a/ir/ir/irgmod.h b/ir/ir/irgmod.h
index 13bada4f2..f3f77fe88 100644
--- a/ir/ir/irgmod.h
+++ b/ir/ir/irgmod.h
@@ -18,45 +18,54 @@
  *
  * @author Martin Trapp, Christian Schaefer
  */
+#ifndef _FIRM_IR_IRGMOD_H_
+#define _FIRM_IR_IRGMOD_H_
 
+#include "firm_types.h"
 
-# ifndef _IRGMOD_H_
-# define _IRGMOD_H_
+/** Exchanges two nodes by conserving edges leaving old (i.e.,
+   pointers pointing to old).  Turns the old node into an Id. */
+void exchange (ir_node *old, ir_node *nw);
 
-# include "irnode.h"
-
-/** Exchanges two nodes by conserving edges leaving old (i.e., pointers
-   pointing to old).  Turns the old node into an Id. Requires that
-   current_ir_graph is set properly. */
-INLINE void exchange (ir_node *old, ir_node *nw);
-
-/** Turns a node into a "useless" Tuple.  The Tuple node just forms a tuple
-   from several inputs.  The predecessors of the tuple have to be
-   set by hand.  The block predecessor automatically remains the same.
-   This is useful if a node returning a tuple is removed, but the Projs
-   extracting values from the tuple are not available. */
+/** Turns a node into a "useless" Tuple.
+ *
+ *  Turns a node into a "useless" Tuple.  The Tuple node just forms a tuple
+ *  from several inputs.  The predecessors of the tuple have to be
+ *  set by hand.  The block predecessor automatically remains the same.
+ *  This is useful if a node returning a tuple is removed, but the Projs
+ *  extracting values from the tuple are not available.
+ *
+ *  @param node The node to be turned into a tuple.
+ *  @param arity The number of values formed into a Tuple.
+ */
 void turn_into_tuple (ir_node *node, int arity);
 
 /** Walks over the passed ir graph and collects all Phi nodes as a
-   list built with the link field in their corresponding block.
-   Further it collects all Proj nodes in a list of the node producing
-   the tuple. In case of nested tuples the Projs are collected in the
-   node producing the outermost Tuple. */
+  * list built with the link field in their corresponding block.
+  * Further it collects all Proj nodes in a list of the node producing
+  * the tuple. In case of nested tuples the Projs are collected in the
+  * node producing the outermost Tuple.
+  * All other link fields are cleared afterwards.
+  */
 void collect_phiprojs(ir_graph *irg);
 
 /** Parts a block into two.  This is useful to insert other blocks within a
-   given block.
-   Adds a new block (new_block) in the control flow before the block
-   (old_block) of node.  Moves node and its predecessors from old_block to
-   new_block.  Moves all Projs that depend on moved nodes and are in old_block
-   to new_block. Moves all Phi nodes from old_block to new_block.  To achieve
-   this the routine assumes that all Phi nodes are in a list (using the link
-   field) in the link field of old_block.  Further it assumes that all Proj nodes
-   are accessible by the link field of the nodes producing the Tuple. This
-   can be established by collect_phiprojs().  part_block conserves this property.
-   Adds a Jmp node to new_block that jumps to old_block.
-   Assumes that node is contained in current_ir_graph.  Sets current_block in
-   this ir_graph to new_block. */
+ *  given block.
+ *
+ * Adds a new block (new_block) in the control flow before the block
+ * (old_block) of node.  Moves node and its predecessors from old_block to
+ * new_block.  Moves all Projs that depend on moved nodes and are in old_block
+ * to new_block. Moves all Phi nodes from old_block to new_block.  To achieve
+ * this the routine assumes that all Phi nodes are in a list (using the link
+ * field) in the link field of old_block.  Further it assumes that all Proj nodes
+ * are accessible by the link field of the nodes producing the Tuple. This
+ * can be established by collect_phiprojs().  part_block conserves this property.
+ * Adds a Jmp node to new_block that jumps to old_block.
+ * Assumes that node is contained in current_ir_graph.  Sets current_block in
+ * this ir_graph to new_block.
+ *
+ * @param node   The node were to break the block
+ */
 void part_block(ir_node *node);
 
-#endif /* ifndef _IRGMOD_H_ */
+#endif /* ifndef _FIRM_IR_IRGMOD_H_ */