From: Michael Beck <beck@ipd.info.uni-karlsruhe.de>
Date: Wed, 15 Mar 2006 17:32:25 +0000 (+0000)
Subject: Improved doxygen documentation.
X-Git-Url: http://nsz.repo.hu/git/?a=commitdiff_plain;h=6123bde12dd39006cee6a4d05b410ad3c12f4a80;p=libfirm

Improved doxygen documentation.
Added a default value.

[r7458]
---

diff --git a/ir/opt/proc_cloning.h b/ir/opt/proc_cloning.h
index 2f514786b..c530dd259 100644
--- a/ir/opt/proc_cloning.h
+++ b/ir/opt/proc_cloning.h
@@ -13,12 +13,19 @@
 
 #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);