- reserve the visited resource

[libfirm] / ir / be / bespilloptions.h

diff --git a/ir/be/bespilloptions.h b/ir/be/bespilloptions.h
index 576a1b9..6381eb1 100644 (file)
--- a/ir/be/bespilloptions.h
+++ b/ir/be/bespilloptions.h
@@ -33,11 +33,34 @@
 extern int be_coalesce_spill_slots;
 extern int be_do_remats;
 
+/**
+ * An entry in the list of spill-algorithms.
+ */
 typedef struct be_spiller_t {
-       void (*spill) (be_irg_t *birg, const arch_register_class_t *cls);
+       /**
+        * The spill function.
+        *
+        * @param birg  the graph to spill on
+        * @param cls   the register class to spill
+        */
+       void (*spill)(be_irg_t *birg, const arch_register_class_t *cls);
 } be_spiller_t;
+
+/**
+ * Register a new spill algorithm.
+ *
+ * @param name     the name of the spill algorithm,
+ *                 used to select it
+ * @param spiller  a spill entry
+ */
 void be_register_spiller(const char *name, be_spiller_t *spiller);
 
+/**
+ * Execute the selected spill algorithm
+ *
+ * @param birg  the graph to spill on
+ * @param cls   the register class to spill
+ */
 void be_do_spill(be_irg_t *birg, const arch_register_class_t *cls);
 
 #endif