some fixes for xml dumper / still buggy.
[libfirm] / ir / tr / typewalk.h
index 7ea32a9..85ddef0 100644 (file)
@@ -1,13 +1,18 @@
 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-
 * All rights reserved.
+*/
+
+/**
+* @file typewalk.h
+*
+* Traverse the type information.
 *
-* Author: Goetz Lindenmaier
+* @author Goetz Lindenmaier
 *
-* traverse the type information.  The walker walks the whole ir graph
+* The walker walks the whole ir graph
 * to find the distinct type trees in the type graph forest.
-* - execute the pre function before recursion
-* - execute the post function after recursion
+* - execute the pre() function before recursion
+* - execute the post() function after recursion
 */
 
 /* $Id$ */
@@ -44,7 +49,11 @@ void type_walk(type_walk_func *pre,
               type_walk_func *post,
               void *env);
 
-/** walks over all type information reachable from irg */
+/** Walks over all type information reachable from an ir graph.
+ *
+ *  Walks over all type information reachable from irg, i.e., starts a
+ *  type walk at the irgs entity, the irgs frame type and all types and
+ *  entities that are attributes to firm nodes. */
 void type_walk_irg(ir_graph *irg,
                   type_walk_func *pre,
                   type_walk_func *post,