Improved doxygen documentation.
authorMichael Beck <beck@ipd.info.uni-karlsruhe.de>
Wed, 15 Mar 2006 17:32:25 +0000 (17:32 +0000)
committerMichael Beck <beck@ipd.info.uni-karlsruhe.de>
Wed, 15 Mar 2006 17:32:25 +0000 (17:32 +0000)
Added a default value.

[r7458]

ir/opt/proc_cloning.h

index 2f51478..c530dd2 100644 (file)
 
 #include "firm_types.h"
 
+/** A default threshold. */
+#define DEFAULT_CLONE_THRESHOLD 300
+
 /**
- * Do the procedure cloning. Evaluate a heuristic weight for every
- * call(..., Const, ...). If the weight is bigger than threshold,
+ * Do procedure cloning. Evaluate a heuristic weight for every
+ * Call(..., Const, ...). If the weight is bigger than threshold,
  * clone the entity and fix the calls.
  *
  * @param threshold   the threshold for cloning
+ *
+ * The threshold is an estimation of how many instructions are saved
+ * when executing a cloned method. If threshold is 0.0, every possible
+ * call is cloned.
  */
 void proc_cloning(float threshold);