minir_dumping should do something usefull now

[libfirm] / include / libfirm / cdep.h

diff --git a/include/libfirm/cdep.h b/include/libfirm/cdep.h
index 102efc4..c1edc73 100644 (file)
--- a/include/libfirm/cdep.h
+++ b/include/libfirm/cdep.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -20,7 +20,7 @@
 /**
  * @file
  * @brief   control dependence analysis
- * @author  Chrsitoph Mallon
+ * @author  Christoph Mallon
  * @version $Id$
  */
 #ifndef FIRM_ANA_CDEP_H
@@ -28,25 +28,58 @@
 
 #include "firm_types.h"
 
-typedef struct cdep cdep;
-struct cdep {
-  ir_node *node;
-  cdep *next;
+/**
+ * An entry in the control dependence list.
+ */
+struct ir_cdep {
+       ir_node *node;  /**< A node on which the current block is control dependent on. */
+       ir_cdep    *next;  /**< Link to the next one if any. */
 };
 
 /** Compute the control dependence graph for a graph. */
 void compute_cdep(ir_graph *irg);
+
+/** Free the control dependence info. */
 void free_cdep(ir_graph *irg);
 
-cdep *find_cdep(const ir_node *block);
+/**
+ * Return a list of all control dependences of a block.
+ */
+ir_cdep *find_cdep(const ir_node *block);
 
+/**
+ * Replace the control dependence info of old by the info of nw.
+ */
 void exchange_cdep(ir_node *old, const ir_node *nw);
 
+/**
+ * Check whether dependee is (directly) control dependent on candidate.
+ *
+ * @param dependee   the (possible) dependent block
+ * @param candidate  the (possible) block on which dependee is dependent
+ */
 int is_cdep_on(const ir_node *dependee, const ir_node *candidate);
 
+/**
+ * Check whether dependee is (possible iterated) control dependent on candidate.
+ *
+ * @param dependee   the (possible) dependent block
+ * @param candidate  the (possible) block on which dependee is dependent
+ */
 int is_iterated_cdep_on(ir_node *dependee, ir_node *candidate);
 
+/**
+ * If block is control dependent on exactly one node, return this node, else NULL.
+ *
+ * @param block  the block to check
+ */
 ir_node *get_unique_cdep(const ir_node *block);
+
+/**
+ * Check if the given block is control dependent of more than one node.
+ *
+ * @param block   the block to check
+ */
 int has_multiple_cdep(const ir_node *block);
 
 #endif