Changeset d17cf8c in mainline for uspace/app/hbench/doc/doxygroups.h

Timestamp:

2019-01-21T13:39:37Z (6 years ago)

Author:

Vojtech Horky <vojtech.horky@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

94d52d5

Parents:

e7f9a09

Message:

hbench: remove global state

Move benchmark parameters into a benchmark environment structure that is
passed to each benchmark.

File:

• uspace/app/hbench/doc/doxygroups.h (modified) (2 diffs)

uspace/app/hbench/doc/doxygroups.h

@@ -19 +19 @@
  * benchmark function to the benchmark_t.
  *
- * The benchmarking function has to accept two arguments:
+ * The benchmarking function has to accept trhee arguments:
+ *  @li bench_env_t: benchmark environment configuration
  *  @li bench_run_t: call bench_run_start and bench_run_stop around the
  *      actual benchmarking code
@@ -27 +28 @@
  * Typically, the structure of the function is following:
  * @code{c}
- * static bool runner(bench_run_t *run, uint64_t size)
+ * static bool runnerconst bench_env_t const *envbench_run_t *run, uint64_t size)
  * {
  *      bench_run_start(run);