added doxygen comments
[libfirm] / ir / be / belive.h
index adb8126..39f0a7f 100644 (file)
@@ -1,18 +1,38 @@
-/**
- * Interblock liveness analysis.
- * @author Sebastian Hack
- * @date   6.12.2004
- * @cvs-id $Id$
- */
+/*
+ * 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.
+ */
+
+/**
+ * @file
+ * @brief       Interblock liveness analysis.
+ * @author      Sebastian Hack
+ * @date        06.12.2004
+ * @version     $Id$
+ */
+#ifndef FIRM_BE_BELIVE_H
+#define FIRM_BE_BELIVE_H
 
-#ifndef _BELIVE_H
-#define _BELIVE_H
+#include <stdio.h>
 
 #include "firm_types.h"
 #include "pset.h"
-#include "bearch_t.h"
 
-#include <stdio.h>
+#include "bearch.h"
 
 typedef enum {
        be_lv_state_in  = 1,
@@ -24,7 +44,6 @@ typedef struct _be_lv_t be_lv_t;
 
 typedef struct _be_lv_info_t be_lv_info_t;
 
-
 /**
  * Compute the inter block liveness for a graph.
  * @param irg The graph.
@@ -49,9 +68,9 @@ void be_liveness_recompute(be_lv_t *lv);
 /**
  * Update the liveness information for a single node.
  * It is irrelevant if there is liveness information present for the node.
- * The liveness information for the node is firstly deleted and then recompute.
- * So, if the node is fresh and never recorded inf the liveness information
- * before, it is more efficient to call be_liveness_introduce().
+ * The liveness information for the node is firstly deleted and then recomputed.
+ * If the node is fresh and never recorded inf the liveness information before,
+ * it is more efficient to call be_liveness_introduce().
  */
 void be_liveness_update(be_lv_t *lv, ir_node *irn);
 
@@ -167,10 +186,4 @@ pset *be_liveness_nodes_live_at(const be_lv_t *lv, const arch_env_t *arch_env, c
  */
 pset *be_liveness_nodes_live_at_input(const be_lv_t *lv, const arch_env_t *arch_env, const arch_register_class_t *cls, const ir_node *pos, pset *live);
 
-
-/**
- * FIXME: Need comment
- */
-void be_liveness_add_missing(be_lv_t *lv);
-
-#endif /* _BELIVE_H */
+#endif /* FIRM_BE_BELIVE_H */