X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Ffirm.h;h=bf0c7dedade531f9364a87860888df0f5f80b3e5;hb=e824e6962c4532b2d1ef5ad9097df6754f8e560a;hp=9e320a06b475d2bda23e852a97839f09f6d0ab35;hpb=d7337be4ef7938bf403e919f71844215a56e10b2;p=libfirm

diff --git a/include/libfirm/firm.h b/include/libfirm/firm.h
index 9e320a06b..bf0c7deda 100644
--- a/include/libfirm/firm.h
+++ b/include/libfirm/firm.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2010 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -21,17 +21,16 @@
  * @file
  * @brief     Central firm header.
  * @author    Martin Trapp, Christian Schaefer, Goetz Lindenmaier
- * @version   $Id$
- * @brief
- *  Central FIRM header.
+ * This header includes all other firm headers and can be included conveniently
+ * by users of the library.
+ */
+
+/** @mainpage
  *
  *  FIRM is a full graph based intermediate representation in SSA Form
  *  with a novel concept to model side effects.  It allows fast, aggressive
  *  optimizations.
  *
- *  This header is the central header of the library implementation of this
- *  IR.
- *
  *  The internal representation of a program in firm is separated into five
  *  different modules:
  *   - Firm Graphs representing the code of a program. (Subdirectory ir.)
@@ -53,8 +52,25 @@
  *
  *   Further this library supplies functionality to build and optimize FIRM graphs
  *   and further functionality needed in a compiler.  Finally there is more
- *   generic functionality to support implementations using firm.  (Code generation,
- *   further optimizations).
+ *   generic functionality to support implementations using firm.
+ *   (Code generation, further optimizations).
+ */
+
+/** @defgroup irana Analyses */
+
+/** @defgroup adt Abstract Data Structures
+ * This module contains abstract datatypes like lists and hashmaps.
+ * They're provided as a convenience, the firm API is fully functionaly without
+ * them so you can just as well use a library like glib and libapr or write
+ * your own.
+ */
+
+/** @defgroup algorithms Algorithms
+ * This module contains generic algorithms like bipartite matching or solvers
+ * for linear equation systems.
+ * They're provided as a convenience, the firm API is fully functionaly without
+ * them so you can just as well use a library like glib and libapr or write
+ * your own.
  */
 #ifndef FIRM_COMMON_FIRM_H
 #define FIRM_COMMON_FIRM_H
@@ -66,14 +82,11 @@
 #include "cgana.h"
 #include "dbginfo.h"
 #include "execfreq.h"
-#include "execution_frequency.h"
-#include "field_temperature.h"
 #include "firm_common.h"
 #include "firmstat.h"
 #include "firm_types.h"
-#include "height.h"
+#include "heights.h"
 #include "ident.h"
-#include "interval_analysis.h"
 #include "irarch.h"
 #include "ircgopt.h"
 #include "irconsconfirm.h"
@@ -83,7 +96,6 @@
 #include "irdump.h"
 #include "iredgekinds.h"
 #include "iredges.h"
-#include "irextbb.h"
 #include "irflag.h"
 #include "irgmod.h"
 #include "irgopt.h"
@@ -102,13 +114,9 @@
 #include "irpass.h"
 #include "irprintf.h"
 #include "irprog.h"
-#include "irsimpletype.h"
 #include "irtypeinfo.h"
-#include "irvrfy.h"
+#include "irverify.h"
 #include "lowering.h"
-#include "rta.h"
-#include "seqnumbers.h"
-#include "structure.h"
 #include "timing.h"
 #include "trouts.h"
 #include "tv.h"