Added support for out edges.

[libfirm] / ir / ana / trouts.h

diff --git a/ir/ana/trouts.h b/ir/ana/trouts.h
index 0cae08d..7bdcf8d 100644 (file)
--- a/ir/ana/trouts.h
+++ b/ir/ana/trouts.h
@@ -11,22 +11,22 @@
  */
 
 /**
-* @file trouts.h
-*
-* Trouts list all uses of types and entities.
-* Each type gets a list of all Alloc nodes allocating it.
-* Each entity gets two lists:
-*   - one containing all accesses (Load, (Call), Store),
-*   - and one containing all uses to get a reference (Sel, SymConst).
-*
-* @todo
-*   To list all uses of entities of a type, we also should list all
-*   static/automatic allocated entities in types.  The Alloc nodes
-*   represent only the dynamic allocated entities.
-*
-* @author Goetz Lindenmaier
-*
-*/
+ * @file trouts.h
+ *
+ * Trouts list all uses of types and entities.
+ * Each type gets a list of all Alloc nodes allocating it.
+ * Each entity gets two lists:
+ *   - one containing all accesses (Load, (Call), Store),
+ *   - and one containing all uses to get a reference (Sel, SymConst).
+ *
+ * @todo
+ *   To list all uses of entities of a type, we also should list all
+ *   static/automatic allocated entities in types.  The Alloc nodes
+ *   represent only the dynamic allocated entities.
+ *
+ * @author Goetz Lindenmaier
+ *
+ */
 
 # ifndef _TROUTS_H_
 # define _TROUTS_H_
@@ -69,8 +69,15 @@ ir_node *get_type_allocation(type *tp, int pos);
 /*------------------------------------------------------------------*/
 
 
+/** Compute the outs of types and entities.
+ *
+ *  Collects all reference from irnodes to types or entities in the
+ *  corresponding types/entities.
+ *
+ *  @todo @@@ We need a flag that signs the consistency of the out information. */
 void compute_trouts(void);
 
+/** Free trout data. */
 void free_trouts(void);