docu: further improvements

[libfirm] / include / libfirm / irgopt.h

diff --git a/include/libfirm/irgopt.h b/include/libfirm/irgopt.h
index a4cf9f7..6df1c2f 100644 (file)
--- a/include/libfirm/irgopt.h
+++ b/include/libfirm/irgopt.h
@@ -21,7 +21,6 @@
  * @file
  * @brief   Optimizations for a whole ir graph, i.e., a procedure.
  * @author  Christian Schaefer, Goetz Lindenmaier, Sebastian Felis
- * @version $Id$
  */
 #ifndef FIRM_IR_IRGOPT_H
 #define FIRM_IR_IRGOPT_H
@@ -29,6 +28,12 @@
 #include "firm_types.h"
 #include "begin.h"
 
+/**
+ * @ingroup iroptimize
+ * @defgroup irgopt  Graph Transformations
+ * @{
+ */
+
 /** Applies local optimizations (see iropt.h) to all nodes reachable from node
  * @p n.
  *
@@ -56,12 +61,17 @@ FIRM_API void local_optimize_graph(ir_graph *irg);
  *
  * @return non-zero if the optimization could be applied, 0 else
  */
+FIRM_API void local_opts(ir_graph *irg);
+
+/** Same functionality as local_opts above, but without framework wrapper
+ * @deprecated
+ */
 FIRM_API int optimize_graph_df(ir_graph *irg);
 
 /**
- * Transforms unreachable blocks and nodes in there into Bad nodes
+ * Eliminates (obviously) unreachable code
  */
-FIRM_API void remove_unreachable_blocks(ir_graph *irg);
+FIRM_API void remove_unreachable_code(ir_graph *irg);
 
 /**
  * Removes all Bad nodes from a graph.
@@ -72,6 +82,15 @@ FIRM_API void remove_unreachable_blocks(ir_graph *irg);
  */
 FIRM_API int remove_bads(ir_graph *irg);
 
+/**
+ * Removes all Tuple nodes from a graph.
+ *
+ * @param irg  The graph to be optimized.
+ *
+ * @return non-zero if at least one Tuple was removed, otherwise 0
+ */
+FIRM_API int remove_tuples(ir_graph *irg);
+
 /**
  * Creates an ir_graph pass for optimize_graph_df().
  *
@@ -105,6 +124,8 @@ FIRM_API void remove_critical_cf_edges(ir_graph *irg);
 FIRM_API void remove_critical_cf_edges_ex(ir_graph *irg,
                                           int ignore_exception_edges);
 
+/** @} */
+
 #include "end.h"
 
 #endif