X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Ffirm.h;h=8ebc5fd41f18d6f9a0918d9d9536bab34d217f91;hb=2c7e601484413ad272d685f9f0cb3ecc27b251f7;hp=351589bbe5985822342fdb0377ad47a57b3d5114;hpb=efa44a3c4bcff43a9d623a65ea2c96f656b5876a;p=libfirm diff --git a/include/libfirm/firm.h b/include/libfirm/firm.h index 351589bbe..8ebc5fd41 100644 --- a/include/libfirm/firm.h +++ b/include/libfirm/firm.h @@ -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,20 @@ * * 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. The firm API is fully functional + * without these abstract datatypes. They're provided as a convenience. + */ + +/** @defgroup algorithms Algorithms + * This module contains generic algorithms. The firm API is fully functional + * without them. They're provided as a convenience. */ #ifndef FIRM_COMMON_FIRM_H #define FIRM_COMMON_FIRM_H @@ -71,7 +82,6 @@ #include "firm_types.h" #include "heights.h" #include "ident.h" -#include "interval_analysis.h" #include "irarch.h" #include "ircgopt.h" #include "irconsconfirm.h" @@ -81,7 +91,6 @@ #include "irdump.h" #include "iredgekinds.h" #include "iredges.h" -#include "irextbb.h" #include "irflag.h" #include "irgmod.h" #include "irgopt.h"