Added missing API docu, improved existing API docu

[libfirm] / include / libfirm / heights.h

diff --git a/include/libfirm/heights.h b/include/libfirm/heights.h
index e3b3848..a101fc4 100644 (file)
--- a/include/libfirm/heights.h
+++ b/include/libfirm/heights.h
@@ -22,11 +22,6 @@
  * @brief   Compute heights of nodes inside basic blocks
  * @author  Sebastian Hack
  * @date    19.04.2006
- * @version $Id$
- *
- * The height is a measure for the longest datadependencies path from a node to
- * the end of a basic block. This is usefull for scheduling heuristics and can
- * also be used to speedup reachability queries.
  */
 #ifndef FIRM_ANA_HEIGHTS_H
 #define FIRM_ANA_HEIGHTS_H
@@ -35,7 +30,18 @@
 #include "begin.h"
 
 /**
- * Get the height of a node inside a basic block.
+ * @ingroup irana
+ * @defgroup ir_heights  Node Heights
+ *
+ * The height is a measure for the longest datadependencies path from a node to
+ * the end of a basic block. This is usefull for scheduling heuristics and can
+ * also be used to speedup reachability queries.
+ *
+ * @{
+ */
+
+/**
+ * Returns the height of a node inside a basic block.
  * The height of the node is the maximal number of edges between a sink node in
  * that block and the node itself (plus 1).
  * @param h    The heights object.
@@ -45,7 +51,7 @@
 FIRM_API unsigned get_irn_height(const ir_heights_t *h, const ir_node *irn);
 
 /**
- * Check, if a certain node is reachable according to data dependence edges
+ * Checks if a certain node is reachable according to data dependence edges
  * from another node. Both nodes must be in the same block.
  * @param h The heights object.
  * @param n The first node.
@@ -56,7 +62,7 @@ FIRM_API int heights_reachable_in_block(ir_heights_t *h, const ir_node *n,
                                         const ir_node *m);
 
 /**
- * Recompute the height information for a certain block.
+ * Recomputes the height information for a certain block.
  * This can be used to recompute the height information of a block.
  * @param h     The heights object.
  * @param block The block
@@ -65,18 +71,20 @@ FIRM_API int heights_reachable_in_block(ir_heights_t *h, const ir_node *n,
 FIRM_API unsigned heights_recompute_block(ir_heights_t *h, ir_node *block);
 
 /**
- * Make a new heights object.
- * This also computes the heights for each block in the graph.
+ * Creates a new heights object. This also computes the heights for each block
+ * in the graph.
  * @param irg The graph.
  */
 FIRM_API ir_heights_t *heights_new(ir_graph *irg);
 
 /**
- * Free a heights object.
+ * Frees a heights object.
  * @param h The heights object.
  */
 FIRM_API void heights_free(ir_heights_t *h);
 
+/** @} */
+
 #include "end.h"
 
 #endif