add documentation make target, fix docu bugs

[libfirm] / include / libfirm / trouts.h

diff --git a/include/libfirm/trouts.h b/include/libfirm/trouts.h
index b3f5555..a6965e0 100644 (file)
--- a/include/libfirm/trouts.h
+++ b/include/libfirm/trouts.h
@@ -22,13 +22,6 @@
  * @brief    Reverse edges that reference types/entities.
  * @author   Goetz Lindenmaier
  * @date     29.10.2004
- * @version  $Id$
- * @brief
- *  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).
  */
 #ifndef FIRM_ANA_TROUTS_H
 #define FIRM_ANA_TROUTS_H
@@ -38,15 +31,16 @@
 
 #include "begin.h"
 
-/*-----------------------------------------------------------------*/
-/* Accessing the trout datastructures.                             */
-/* These routines only work properly if firm is in state           */
-/* trouts_consistent or trouts_inconsistent.                       */
-/*-----------------------------------------------------------------*/
-
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
-/* entities                                                        */
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
+/**
+ * @ingroup ir_type
+ * @defgroup trouts Reverse Type Edges
+ * 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).
+ * @{
+ */
 
 /** Number of Load/Store nodes that possibly access this entity. */
 FIRM_API size_t get_entity_n_accesses(const ir_entity *ent);
@@ -60,10 +54,6 @@ FIRM_API size_t get_entity_n_references(const ir_entity *ent);
  *  Including references from constants. */
 FIRM_API ir_node *get_entity_reference(const ir_entity *ent, size_t pos);
 
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
-/* types                                                           */
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
-
 /** Number of Alloc nodes that create an instance of this type. */
 FIRM_API size_t get_type_n_allocs(const ir_type *tp);
 /** Alloc node that create an instance of this type. */
@@ -79,30 +69,14 @@ FIRM_API size_t get_class_n_upcasts(const ir_type *clss);
 /** Return number of downcasts. O(\#casts). */
 FIRM_API size_t get_class_n_downcasts(const ir_type *clss);
 
-/* Access all pointer types that point to tp. */
 FIRM_API size_t  get_type_n_pointertypes_to(const ir_type *tp);
 FIRM_API ir_type *get_type_pointertype_to(const ir_type *tp, size_t pos);
 FIRM_API void    add_type_pointertype_to(const ir_type *tp, ir_type *ptp);
 
-/* Access all array types that contain elements of type tp.
- * Does not find subarrays, e.g., int[] being element of int[][]
- * for multi dimensional arrays. */
 FIRM_API size_t  get_type_n_arraytypes_of(const ir_type *tp);
 FIRM_API ir_type *get_type_arraytype_of(const ir_type *tp, size_t pos);
 FIRM_API void    add_type_arraytype_of(const ir_type *tp, ir_type *atp);
 
-/*------------------------------------------------------------------*/
-/* Building and Removing the trout datastructure                    */
-/*------------------------------------------------------------------*/
-
-/** The state of the tr_out datastructure.
- *
- *  We reuse the enum of irouts.
- *  @see irouts.h. */
-FIRM_API irg_outs_state get_trouts_state(void);
-/** Set the tr out state to inconsistent if it is consistent. */
-FIRM_API void           set_trouts_inconsistent(void);
-
 /** Compute the outs of types and entities.
  *
  *  Collects all reference from irnodes to types or entities in the
@@ -130,6 +104,8 @@ FIRM_API void compute_trouts(void);
 /** Free trout data. */
 FIRM_API void free_trouts(void);
 
+/** @} */
+
 #include "end.h"
 
 #endif