X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Firouts.h;h=a4c2e4447639fd4f758802d040f208d11356adf0;hb=332cda9a138297c9852e2ef0f649c92b640723f4;hp=93c77709f284de50f1c290a03b6e68f958e1eb1f;hpb=1a3b7d363474ab544c13093a2f0b578718d37c7a;p=libfirm

diff --git a/include/libfirm/irouts.h b/include/libfirm/irouts.h
index 93c77709f..a4c2e4447 100644
--- a/include/libfirm/irouts.h
+++ b/include/libfirm/irouts.h
@@ -22,7 +22,6 @@
  * @brief    Compute and access out edges (also called def-use edges).
  * @author   Goetz Lindenmaier, Michael Beck
  * @date     1.2002
- * @version  $Id$
  */
 #ifndef FIRM_ANA_IROUTS_H
 #define FIRM_ANA_IROUTS_H
@@ -30,29 +29,28 @@
 #include "firm_types.h"
 #include "begin.h"
 
-/*------------------------------------------------------------------*/
-/* Accessing the out datastructures.                                */
-/* These routines only work properly if the ir_graph is in state    */
-/* outs_consistent or outs_inconsistent.                            */
-/*------------------------------------------------------------------*/
+/**
+ * @ingroup irana
+ * @defgroup irout Reverse Edges
+ * Out-Edges are the reverse of the edges in a firm graph (also called def-use
+ * edges)
+ * @{
+ */
 
-/** To iterate through the successors iterate from 0 to i < get_irn_outs(). No
-   order of successors guaranteed.  Will return edges from block to floating
-   nodes even if irgraph is in state "op_pin_state_floats". */
-/* returns the number of successors of the node: */
+/** Returns the number of successors of the node: */
 FIRM_API int get_irn_n_outs(const ir_node *node);
 
-/** Get the User of a node from the Def-Use edge at position pos. */
+/** Returns the User of a node from the Def-Use edge at position pos. */
 FIRM_API ir_node *get_irn_out(const ir_node *def, int pos);
 
 /**
- * Get the User and its input position from the Def-Use edge of def
+ * Returns the User and its input position from the Def-Use edge of def
  * at position pos.
  */
 FIRM_API ir_node *get_irn_out_ex(const ir_node *def, int pos, int *in_pos);
 
 /**
- * Set the User at position pos.
+ * Sets the User at position pos.
  *
  * @param def     the Def node
  * @param pos     the number of the Def-Use edge tat is modified
@@ -61,13 +59,10 @@ FIRM_API ir_node *get_irn_out_ex(const ir_node *def, int pos, int *in_pos);
  */
 FIRM_API void set_irn_out(ir_node *def, int pos, ir_node *use, int in_pos);
 
-/* Methods to iterate through the control flow graph. Iterate from 0 to
-   i < get_Block_cfg_outs(block). No order of successors guaranteed. */
-
-/** Return the number of control flow successors, ignore keep-alives. */
+/** Returns the number of control flow successors, ignore keep-alives. */
 FIRM_API int get_Block_n_cfg_outs(const ir_node *node);
 
-/** Return the number of control flow successors, honor keep-alives. */
+/** Returns the number of control flow successors, honor keep-alives. */
 FIRM_API int get_Block_n_cfg_outs_ka(const ir_node *node);
 
 /** Access predecessor n, ignore keep-alives. */
@@ -76,40 +71,48 @@ FIRM_API ir_node *get_Block_cfg_out(const ir_node *node, int pos);
 /** Access predecessor n, honor keep-alives. */
 FIRM_API ir_node *get_Block_cfg_out_ka(const ir_node *node, int pos);
 
-/** Walks over the graph starting at node.  Walks also if graph is in state
-   "outs_inconsistent".  Assumes current_ir_graph is set properly. */
+/**
+ * Walks over the graph starting at node.  Walks also if graph is in state
+ * "outs_inconsistent".  Assumes current_ir_graph is set properly.
+ */
 FIRM_API void irg_out_walk(ir_node *node, irg_walk_func *pre,
                            irg_walk_func *post, void *env);
 
-/** Walks only over Block nodes in the graph.  Has its own visited
-   flag, so that it can be interleaved with the other walker.
-   node must be either op_Block or mode_X.  */
+/**
+ * Walks only over Block nodes in the graph.  Has its own visited
+ * flag, so that it can be interleaved with the other walker.
+ * node must be either op_Block or mode_X.
+ */
 FIRM_API void irg_out_block_walk(ir_node *node, irg_walk_func *pre,
                                  irg_walk_func *post, void *env);
 
 /**
- * returns 1 if outs have been computed for a node, 0 otherwise.
+ * Returns 1 if outs have been computed for a node, 0 otherwise.
  *
- *  this is useful to detect newly created nodes that have no outs set yet
+ * this is useful to detect newly created nodes that have no outs set yet
  */
 FIRM_API int get_irn_outs_computed(const ir_node *node);
 
-/*------------------------------------------------------------------*/
-/* Building and Removing the out datastructure                      */
-/*------------------------------------------------------------------*/
-
-/** Computes the out edges.  Sets a flag in irg to "outs_consistent".  If the
-    graph is changed this flag must be set to "outs_inconsistent".  Computes
-    out edges from block to floating nodes even if graph is in state
-   "op_pin_state_floats".   Optimizes Tuple nodes. */
+/**
+ * Computes the out edges.  Sets a flag in irg to "outs_consistent".  If the
+ * graph is changed this flag must be set to "outs_inconsistent".  Computes
+ * out edges from block to floating nodes even if graph is in state
+ * "op_pin_state_floats".   Optimizes Tuple nodes.
+ */
 FIRM_API void compute_irg_outs(ir_graph *irg);
+/** Recomputes out edges for each graph where it is necessary */
 FIRM_API void compute_irp_outs(void);
 
+/** Recomputes out edges if necessary */
 FIRM_API void assure_irg_outs(ir_graph *irg);
 
+/** Frees memory occupied by out edges datastructures */
 FIRM_API void free_irg_outs(ir_graph *irg);
+/** Frees memory occupied by out edges datastructures in the whole program */
 FIRM_API void free_irp_outs(void);
 
+/** @} */
+
 #include "end.h"
 
 #endif