doxygen comment updated

[libfirm] / ir / ana / irtypeinfo.h

diff --git a/ir/ana/irtypeinfo.h b/ir/ana/irtypeinfo.h
index d39456a..7ed47cd 100644 (file)
--- a/ir/ana/irtypeinfo.h
+++ b/ir/ana/irtypeinfo.h
@@ -19,24 +19,20 @@
  * graph is valid.  Further it defines an auxiliary type "init_type".
  *
  */
+#ifndef _IRTYPEINFO_H_
+#define _IRTYPEINFO_H_
 
-
-# ifndef _IRTYPEINFO_H_
-# define _IRTYPEINFO_H_
-
-# include "irgraph.h"
-# include "irnode.h"
-# include "type.h"
+#include "firm_types.h"
 
 /* ------------ Auxiliary type. --------------------------------------- */
 
 /** An auxiliary type used to express that a field is uninitialized.
  *
  *  This auxiliary type expresses that a field is uninitialized.  The
- *  variable is set by init_irtypeinfo.  The type is freed by
- *  free_irtypeinfo.
+ *  variable is initialized by init_irtypeinfo().  The type is freed by
+ *  free_irtypeinfo().
  */
-extern type *initial_type;
+extern ir_type *initial_type;
 
 
 
@@ -45,9 +41,9 @@ extern type *initial_type;
 /** Initializes the type information module.
  *
  *  Initializes the type information module.
- *  Generates a type "init_type" and sets the type of all nodes to this type.
- *  Calling set/get_irn_type is invalid before calling init. Requires memory
- *  in the order of MIN(<calls to set_irn_type>, #irnodes).
+ *  Generates a type inititial_type and sets the type of all nodes to this type.
+ *  Calling set/get_irn_typeinfo_type() is invalid before calling init. Requires memory
+ *  in the order of MIN(<calls to set_irn_typeinfo_type>, #irnodes).
  */
 void init_irtypeinfo(void);
 void free_irtypeinfo(void);
@@ -62,9 +58,9 @@ void free_irtypeinfo(void);
 */
 
 typedef enum {
-  ir_typeinfo_none,         /**< No typeinfo computed, calls to set/get_irn_type
+  ir_typeinfo_none,         /**< No typeinfo computed, calls to set/get_irn_typeinfo_type()
                                  are invalid. */
-  ir_typeinfo_consistent,   /**< Type info valid, calls to set/get_irn_type return
+  ir_typeinfo_consistent,   /**< Type info valid, calls to set/get_irn_typeinfo_type() return
                                  the proper type. */
   ir_typeinfo_inconsistent  /**< Type info can be accessed, but it can be invalid
                                  because of other transformations. */
@@ -92,7 +88,7 @@ void              set_irp_typeinfo_inconsistent(void);
  * ir_typeinfo_consistent or ir_typeinfo_inconsistent.  They
  * assume current_ir_graph set properly.
  */
-type *get_irn_typeinfo_type(ir_node *n);
-void  set_irn_typeinfo_type(ir_node *n, type *tp);
+ir_type *get_irn_typeinfo_type(ir_node *n);
+void    set_irn_typeinfo_type(ir_node *n, ir_type *tp);
 
 #endif /* _IRTYPEINFO_H_ */