rename type entity into ir_entity

[libfirm] / ir / st / st.h

diff --git a/ir/st/st.h b/ir/st/st.h
index 37e2894..37c74fd 100644 (file)
--- a/ir/st/st.h
+++ b/ir/st/st.h
@@ -1,17 +1,24 @@
-/* Copyright (c) 2002 by Universität Karlsruhe (TH).  All Rights Reserved  */
-
+/*
+ * Project:     libFIRM
+ * File name:   ir/st/st.h
+ * Purpose:     Provide some auxilliary structures for firm graphs.
+ * Author:      Florian Liekweg
+ * Modified by:
+ * Created:     26.2.2002
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 2002-2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
 /**
-   NAME
-     st.h
-   PURPOSE
-     provide some auxilliary structures for firm graphs.
-   S
+   @file st.h
+
+   Provide some auxilliary structures for firm graphs.
+
+   @author Florian Liekweg
+
+   @note
      not quite complete
-   HISTORY
-     liekweg - Feb 26, 2002: Created.
-   CVS:
-     $Id$
-***/
+*/
 
 # ifndef _ST_H_
 # define _ST_H_
@@ -27,18 +34,18 @@
 
 /* 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 +55,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;