kinds to be added to datastructures

[libfirm] / ir / common / firm.h

diff --git a/ir/common/firm.h b/ir/common/firm.h
index c95c0c3..5f5296f 100644 (file)
--- a/ir/common/firm.h
+++ b/ir/common/firm.h
@@ -2,12 +2,13 @@
 * All rights reserved.
 *
 * Authors: Martin Trapp, Christian Schaefer, Goetz Lindenmaier.
-*
-* firm.h: Central FIRM header.
-*
-*
-*
-*
+*/
+
+/**
+ @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.
@@ -80,6 +81,8 @@
 # include "irgmod.h"     /* Support to modify ir */
 # include "irgwalk.h"    /* Support to walk ir */
 # include "typewalk.h"   /* Support to walk type information */
+# include "typegmod.h"   /* Support to modify type graph */
+# 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
@@ -87,7 +90,15 @@
    files. */
 # include "irdump.h"
 
-/* initialize firm */
-void init_firm (void);
+/**
+ * Initialize the firm library.
+ *
+ * @param func    This function is called, whenever a local variable is used before definition
+ *
+ * The parameter func may be NULL. In that case, the old FIRM behavior is conserved.
+ *
+ * @see default_initialize_local_variable_func_t
+ */
+void init_firm (default_initialize_local_variable_func_t *func);
 
 # endif /* _FIRM_H_ */