-/* Copyright (C) 2000 by Universitaet Karlsruhe
-** All rights reserved.
-**
-** Authors: Goetz Lindenmaier
-**
-** irprog.h: ir representation of a program
-**
-** This file defines a construct that keeps all information about a
-** program:
-** - A list of all procedures.
-** - A list of all types.
-** - A global type that can be thought of as a god-class containing all
-** global variables and procedures. This is not the base class of
-** all classes in a class hierarchy (as, e.g., "object" in java).
-** - (An obstack containing global things, e.g., the above mentioned lists.)
+/*
+ * Project: libFIRM
+ * File name: ir/ir/irprog.h
+ * Purpose: Entry point to the representation of a whole program.
+ * Author: Goetz Lindenmaier
+ * Modified by:
+ * Created: 2000
+ * CVS-ID: $Id$
+ * Copyright: (c) 2000-2003 Universität Karlsruhe
+ * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
+ */
+
+/**
+* @file irprog.h
+*
+* ir representation of a program.
+*
+* @author Goetz Lindenmaier
+*
+* This file defines a construct that keeps all information about a
+* program:
+* - A reference point to the method to be executed on program start.
+* - A list of all procedures.
+* - A list of all types.
+* - A global type that contais all global variables and procedures that do
+* not belong to a class. This type represents the data segment of the
+* program. It is not the base class of
+* all classes in a class hierarchy (as, e.g., "object" in java).
+* - A degenerated graph that contains constant expressions.
+* - interprocedural outs state.
+* - a flag indicating validity of the interprocedural representation.
+* - the output file name