Added Goetz' proposal to replace loads of constant entities by their constants

[libfirm] / ir / ana / rta.h

diff --git a/ir/ana/rta.h b/ir/ana/rta.h
index 5e4574d..6ab29e8 100644 (file)
--- a/ir/ana/rta.h
+++ b/ir/ana/rta.h
@@ -5,26 +5,51 @@
 
 # include "entity.h"
 
-/* Initialise the RTA data structures and perform RTA */
-void rta_init(int, int);
-/* Delete all graphs that have been found to be dead */
+/**
+ * Initialise the RTA data structures and perform RTA.
+ *
+ * @param do_verbose If == 1, print statistics, if > 1, chatter about every detail
+ */
+void rta_init(int do_verbose);
+
+/**
+ * Delete all graphs that have been found to be dead.
+ */
 void rta_delete_dead_graphs (void);
-/* Clean up our data structures */
+
+/** Clean up our data structures.
+ * Finishes the RTA.
+ */
 void rta_cleanup(void);
 
-/* Inquire whether the given class is live */
+/** Returns non-zero if the given class is alive. */
 int rta_is_alive_class(type *clazz);
-/* Inquire whether the given graph is alive */
+
+/** Returns non-zero if the given graph is alive. */
 int rta_is_alive_graph(ir_graph *graph);
-/* Inquire whether the given field is alive */
-int rta_is_alive_field(entity *field);
-/* dump our opinion */
+
+/** report for all graphs and types whether they are alive */
 void rta_report (void);
 
-#endif /* def _RTA_H_ */
+#endif /* not defined _RTA_H_ */
 
 /*
  * $Log$
+ * Revision 1.12  2004/10/20 14:59:27  liekweg
+ * Removed ecg
+ *
+ * Revision 1.11  2004/10/18 12:47:46  liekweg
+ * minor fix
+ *
+ * Revision 1.10  2004/09/24 13:59:04  beck
+ * fixed doxygen comments, removed initialization for description entities
+ *
+ * Revision 1.9  2004/08/19 16:51:02  goetz
+ * fixed some errors, pushed closer to inteded firm semantics
+ *
+ * Revision 1.8  2004/06/18 17:34:31  liekweg
+ * Removed field checks --flo
+ *
  * Revision 1.7  2004/06/18 13:12:43  liekweg
  * final bug fix (calls via consts)
  *