More docu added

[libfirm] / ir / common / firm.h

diff --git a/ir/common/firm.h b/ir/common/firm.h
index 58d21d1..bc9d476 100644 (file)
--- a/ir/common/firm.h
+++ b/ir/common/firm.h
@@ -1,13 +1,14 @@
 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-** All rights reserved.
-**
-** Authors: Martin Trapp, Christian Schaefer, Goetz Lindenmaier.
-**
-** firm.h: Central FIRM header.
-**
-**
-**
-**
+* All rights reserved.
+*
+* Authors: Martin Trapp, Christian Schaefer, Goetz Lindenmaier.
+*/
+
+/**
+ @file firm.h
+
+    Central FIRM header.
+
     FIRM is a full graph based intermediate representation in SSA Form
     with a novel concept to model side effects.  It allows fast, aggressive
     optimizations.
@@ -50,7 +51,7 @@
 
      irgwalk: walker for ir graphs.
      irvrfy:  verify the correctness of a firm node.
-**
+*
 */
 
 /* $Id$ */
@@ -73,13 +74,24 @@
 # include "ircgopt.h"    /* Optimizations based on interprocedural graph */
 
 # include "irdom.h"      /* Dominator analysis */
-# include "cgana.h"      /* Analysis to construct interprocedural graph
-                           including some optimizations */
+# include "cgana.h"      /* Analysis to construct interprocedural graph */
+                         /* including some optimizations */
+# include "irloop.h"     /* loop and backedge analysis */
 
 # include "irgmod.h"     /* Support to modify ir */
 # include "irgwalk.h"    /* Support to walk ir */
+# include "typewalk.h"   /* Support to walk type information */
+# include "mangle.h"     /* Support for mangling ident names. */
+
+/* @@@ temporarily for jni builder until preprocessor works.
+   Then it should be sufficient to include <file.h> instead
+   of firm.h as not all enums are needed in the impelmentation
+   files. */
+# include "irdump.h"
 
-/* initialize firm */
+/**
+ * Initialize the firm library.
+ */
 void init_firm (void);
 
 # endif /* _FIRM_H_ */