removed unused header
[libfirm] / ir / st / st.h
index 37e2894..9641329 100644 (file)
@@ -1,20 +1,32 @@
-/* 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.
-   S
-     not quite complete
-   HISTORY
-     liekweg - Feb 26, 2002: Created.
-   CVS:
-     $Id$
-***/
-
-# ifndef _ST_H_
-# define _ST_H_
+ * @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
 
 /* Includes:  */
 #include "irgraph.h"
 
 /* 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;
@@ -48,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;
@@ -71,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