Add doc specifying the scope of the timing calculation

Fixes #479
This commit is contained in:
Dominic Hamon 2017-11-13 09:20:12 -08:00 committed by GitHub
parent 5e66248b44
commit ed5764ea28
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -40,6 +40,8 @@ BENCHMARK_MAIN();
Don't forget to inform your linker to add benchmark library e.g. through `-lbenchmark` compilation flag. Don't forget to inform your linker to add benchmark library e.g. through `-lbenchmark` compilation flag.
The benchmark library will reporting the timing for the code within the `for(...)` loop.
### Passing arguments ### Passing arguments
Sometimes a family of benchmarks can be implemented with just one routine that Sometimes a family of benchmarks can be implemented with just one routine that
takes an extra argument to specify which one of the family of benchmarks to takes an extra argument to specify which one of the family of benchmarks to