diff options
author | Heather Miller <heather.miller@epfl.ch> | 2011-07-24 00:32:01 +0000 |
---|---|---|
committer | Heather Miller <heather.miller@epfl.ch> | 2011-07-24 00:32:01 +0000 |
commit | b204a9360fadf090b8f84c04b4f73423f575516e (patch) | |
tree | 353c24dcfccf7d40aa8cd36b021e5a9c741e28bc | |
parent | c3c1c65d5fa2a6fd94e8f3bda7c5b4b5408bb789 (diff) | |
download | scala-b204a9360fadf090b8f84c04b4f73423f575516e.tar.gz scala-b204a9360fadf090b8f84c04b4f73423f575516e.tar.bz2 scala-b204a9360fadf090b8f84c04b4f73423f575516e.zip |
Updated documentation for testing.Benchmark.
-rw-r--r-- | src/library/scala/testing/Benchmark.scala | 9 |
1 files changed, 8 insertions, 1 deletions
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 */ |