inlinening of functions

[libfirm] / ir / tr / typewalk.h

diff --git a/ir/tr/typewalk.h b/ir/tr/typewalk.h
index e00a36b..ee8978b 100644 (file)
--- a/ir/tr/typewalk.h
+++ b/ir/tr/typewalk.h
@@ -1,29 +1,35 @@
-/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-* All rights reserved.
-*/
+/*
+ * Project:     libFIRM
+ * File name:   ir/tr/typewalk.h
+ * Purpose:     Traverse the type information.
+ * Author:      Goetz Lindenmaier
+ * Modified by:
+ * Created:
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 1999-2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
 
 /**
-* @file typewalk.h
-*
-* Traverse the type information.
-*
-* @author Goetz Lindenmaier
-*
-* 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
-*/
-
-/* $Id$ */
-
-
-/* walk over all type information reachable from the ir graph. */
+ * @file typewalk.h
+ *
+ * Traverse the type information.
+ *
+ * @author Goetz Lindenmaier
+ *
+ * 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
+ */
 
 #ifndef _TYPEWALK_H_
 #define _TYPEWALK_H_
 
-# include "type_or_entity.h"
+#include "type.h"
+#include "type_or_entity.h"
+
+#include "irgraph.h"
 
 /**
  * the type walk function
@@ -49,7 +55,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,