* @file
* @brief Central firm header.
* @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier
- * @brief Central FIRM header.
+ * This header includes all other firm headers and can be included conveniently
+ * by users of the library.
*/
/** @mainpage
* 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.)
* 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
#include "irdump.h"
#include "iredgekinds.h"
#include "iredges.h"
-#include "irextbb.h"
#include "irflag.h"
#include "irgmod.h"
#include "irgopt.h"