used ircons_t.h now

[libfirm] / ir / ir / irgmod.h

diff --git a/ir/ir/irgmod.h b/ir/ir/irgmod.h
index 57f2e1d..3e068e9 100644 (file)
--- a/ir/ir/irgmod.h
+++ b/ir/ir/irgmod.h
@@ -1,36 +1,55 @@
-/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-** All rights reserved.
-**
-** Authors: Martin Trapp, Christian Schaefer
-**
-** irgmod.h: ir graph modification
-*/
+/*
+ * Project:     libFIRM
+ * File name:   ir/ir/irgmod.h
+ * Purpose:     Support for ir graph modification.
+ * Author:      Martin Trapp, Christian Schaefer
+ * Modified by: Goetz Lindenmaier
+ * Created:
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 1998-2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
+
+/**
+ *
+ * @file irgmod.h
+ *
+ * ir graph modification.
+ *
+ * @author Martin Trapp, Christian Schaefer
+ */
+
 
 # ifndef _IRGMOD_H_
 # define _IRGMOD_H_
 
 # include "irnode.h"
 
-/* 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. */
-void turn_into_tuple (ir_node *node, int arity);
+/** 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);
 
-/* 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 *new);
+/** 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
+/** 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. */
 void collect_phiprojs(ir_graph *irg);
 
-/* Parts a block into two.  This is useful to insert other blocks within a
+/** 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