fixed some depencies between irdump.c and irdumptxt.c

[libfirm] / ir / tr / typewalk.h

diff --git a/ir/tr/typewalk.h b/ir/tr/typewalk.h
index ee8978b..cbdef13 100644 (file)
--- a/ir/tr/typewalk.h
+++ b/ir/tr/typewalk.h
@@ -31,29 +31,25 @@
 
 #include "irgraph.h"
 
-/**
- * the type walk function
+/** Type of argument functions for type walkers.
  *
  * @param tore    points to the visited type or entity
  * @param env     free environment pointer
  */
 typedef void type_walk_func(type_or_ent *tore, void *env);
 
-/**
- * the class walk function
+/**  The class walk function
  *
  * @param clss    points to the visited class
  * @param env     free environment pointer
  */
 typedef void class_walk_func(type *clss, void *env);
 
-/**
-    Touches every type and entity in unspecified order.  If new
-    types/entities are created during the traversal these will
-    be visited, too. */
-void type_walk(type_walk_func *pre,
-              type_walk_func *post,
-              void *env);
+/** Touches every type and entity in unspecified order.  If new
+ *  types/entities are created during the traversal these will
+ *  be visited, too.
+ *  Does not touch frame types or types for value params ... */
+void type_walk(type_walk_func *pre, type_walk_func *post, void *env);
 
 /** Walks over all type information reachable from an ir graph.
  *
@@ -103,7 +99,7 @@ void class_walk_super2sub(class_walk_func *pre,
                          void *env);
 
 /**
- * the entity walk function
+ * the entity walk function.  A function type for entity walkers.
  *
  * @param ent     points to the visited entity
  * @param env     free environment pointer
@@ -115,9 +111,10 @@ typedef void entity_walk_func(entity *ent, void *env);
  *
  * @param tp    the type
  * @param doit  the entity walker function
- * @param env   environment, wil be passed to the walker function
+ * @param env   environment, will be passed to the walker function
  */
 void walk_types_entities(type *tp,
                         entity_walk_func *doit,
                         void *env);
+
 #endif /* _TYPEWALK_H_ */