From b204a9360fadf090b8f84c04b4f73423f575516e Mon Sep 17 00:00:00 2001
From: Heather Miller <heather.miller@epfl.ch>
Date: Sun, 24 Jul 2011 00:32:01 +0000
Subject: Updated documentation for testing.Benchmark.

---
 src/library/scala/testing/Benchmark.scala | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/library/scala/testing/Benchmark.scala b/src/library/scala/testing/Benchmark.scala
index 936db014c0..90a9292db2 100644
--- a/src/library/scala/testing/Benchmark.scala
+++ b/src/library/scala/testing/Benchmark.scala
@@ -22,7 +22,14 @@ import compat.Platform
  *  {{{
  *  > scala sort1 5
  *  }}}
- *  This will run the benchmark 10 times, and print the execution times to stdout.
+ *  This will run the benchmark 5 times, forcing a garbage collection
+ *  between runs, and printing the execution times to stdout.
+ *
+ *  It is also possible to add a multiplier, so
+ *  {{{
+ *  > scala sort1 5 10
+ *  }}}
+ *  will run the entire benchmark 10 times, each time for 5 runs.
  *
  *  @author Iulian Dragos, Burak Emir
  */
-- 
cgit v1.2.3