removed unused header

[libfirm] / ir / st / st.h

diff --git a/ir/st/st.h b/ir/st/st.h
index 81da246..9641329 100644 (file)
--- a/ir/st/st.h
+++ b/ir/st/st.h
@@ -1,46 +1,56 @@
-// Copyright (c) 2002 by Universität Karlsruhe (TH).  All Rights Reserved
+/*
+ * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
+ */
 
-/***
-   NAME
-     st.h
-   PURPOSE
-     provide some auxilliary structures for firm graphs.
-   NOTES
-     not quite complete
-   HISTORY
-     liekweg - Feb 26, 2002: Created.
-   CVS:
-     $Id$
-***/
+/**
+ * @file
+ * @brief     Provide some auxilliary structures for firm graphs.
+ * @author    Florian Liekweg
+ * @date      26.2.2002
+ * @version   $Id$
+ * @note      not quite complete
+ */
+#ifndef FIRM_ST_ST_H
+#define FIRM_ST_ST_H
 
-# ifndef _ST_H_
-# define _ST_H_
+/* Includes:  */
+#include "irgraph.h"
+#include "irnode.h"
 
-// Includes:
-# include "irgraph.h"
-# include "irnode.h"
+#include "bs.h"
 
-# include "bs.h"
+#include <stdbool.h>
 
-#  include "bool.h"
 
-#define true TRUE
-#define false FALSE
+/* Data Types: */
 
-// Data Types:
-
-// One dominator tree
+/**  One dominator tree */
 typedef struct
 {
   int n_blocks;
-  ir_graph *graph;                             // PRE
+  ir_graph *graph;     /**< PRE */
   ir_node **blocks;
-  ir_node **idoms;                             // idom [n] == immediate dominator of blocks [n]
+  ir_node **idoms;     /**< idom [n] == immediate dominator of blocks [n] */
   bs_t *masks;
 }
 dt_t;
 
-// List entry:
+/** List entry.  */
 typedef struct dtree_t
 {
   dt_t *tree;
@@ -50,7 +60,7 @@ typedef struct dtree_t
 }
 dtree_t;
 
-// dominator environment for a node @a in graph @graph
+/** dominator environment for a node dom_env_t::a in graph dom_env_t::graph */
 typedef struct dom_env_t
 {
   dt_t     *dt;
@@ -60,11 +70,11 @@ typedef struct dom_env_t
   bs_t      mask;
 } dom_env_t;
 
-// Forwards for Globals:
+/* Forwards for Globals:  */
 extern dtree_t *trees;
 extern dtree_t *last;
 
-// Prototypes:
+/* Prototypes: */
 void     st_build_dominator_tree (ir_graph*);
 bool     dominates            (ir_graph*, ir_node*, ir_node*);
 ir_node *get_idom             (ir_graph*, ir_node*);
@@ -73,4 +83,4 @@ dom_env_t *get_dom_env (ir_graph*, ir_node*);
 void delete_dom_env (dom_env_t*);
 bool dominates_l (dom_env_t*, ir_node*);
 
-# endif /* defined _ST_H_ */
+#endif