Adding usage example for BENCHMARK_DRAW_LINE()
authorMarcelo Juchem <marcelo@fb.com>
Tue, 6 Nov 2012 23:16:05 +0000 (15:16 -0800)
committerJordan DeLong <jdelong@fb.com>
Sun, 16 Dec 2012 22:43:13 +0000 (14:43 -0800)
Summary:
Yes, I admit, I was dumb enough to try it in a benchmark's
body.

Test Plan: review

Reviewed By: tudorb@fb.com

FB internal diff: D622613

folly/docs/Benchmark.md

index 2273a7830cd8456f9471489487930dcaf97b0e61..c1be39fbe3d6d3eef00342e96c72abcc1ee0d58d 100644 (file)
@@ -178,6 +178,20 @@ group or for whatever reason), use `BENCHMARK_DRAW_LINE()`. The line
 fulfills a purely aesthetic role; it doesn't interact with
 measurements in any way.
 
+``` Cpp
+    BENCHMARK(foo) {
+      Foo foo;
+      foo.doSomething();
+    }
+
+    BENCHMARK_DRAW_LINE();
+
+    BENCHMARK(bar) {
+      Bar bar;
+      bar.doSomething();
+    }
+```
+
 ### Suspending a benchmark
 ***