diff options
| author | fanquake <fanquake@gmail.com> | 2019-10-28 09:18:24 -0400 |
|---|---|---|
| committer | fanquake <fanquake@gmail.com> | 2019-10-28 09:26:44 -0400 |
| commit | 1ab6c1267e342e034758d4c18e0b3291705d7edb (patch) | |
| tree | 06a164921e5fa6f17fe7f05642060bf89aa5552d /src/test/cuckoocache_tests.cpp | |
| parent | badca85e2c0bf1720fca8a516adbf4b3f1d7e4d9 (diff) | |
| parent | 7aad3b68e7e1680870ca70d945eee88f790d6454 (diff) | |
Merge #16986: doc: Doxygen-friendly CuckooCache comments
7aad3b68e7e1680870ca70d945eee88f790d6454 doc: Doxygen-friendly CuckooCache comments (Jon Layton)
Pull request description:
Similar theme to #16947.
- `invalid`, `contains` now appear in Doxygen docs
- `setup` refers to correct argument name `b`
- Argument references in `code blocks `
- Lists markdown conformant, uniform line endings
Tested with `make docs`
ACKs for top commit:
laanwj:
ACK 7aad3b68e7e1680870ca70d945eee88f790d6454
practicalswift:
ACK 7aad3b68e7e1680870ca70d945eee88f790d6454
Tree-SHA512: 70b38c10e534bad9c6ffcd88cc7a4797644afba5956d47a6c7cc655fcd5857a91f315d6da60e28ce9678d420ed4a51e22267eb8b89e26002b99cad63373dd349
Diffstat (limited to 'src/test/cuckoocache_tests.cpp')
| -rw-r--r-- | src/test/cuckoocache_tests.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/test/cuckoocache_tests.cpp b/src/test/cuckoocache_tests.cpp index d38ede691a..a3017da3e7 100644 --- a/src/test/cuckoocache_tests.cpp +++ b/src/test/cuckoocache_tests.cpp @@ -10,11 +10,11 @@ /** Test Suite for CuckooCache * - * 1) All tests should have a deterministic result (using insecure rand + * 1. All tests should have a deterministic result (using insecure rand * with deterministic seeds) - * 2) Some test methods are templated to allow for easier testing + * 2. Some test methods are templated to allow for easier testing * against new versions / comparing - * 3) Results should be treated as a regression test, i.e., did the behavior + * 3. Results should be treated as a regression test, i.e., did the behavior * change significantly from what was expected. This can be OK, depending on * the nature of the change, but requires updating the tests to reflect the new * expected behavior. For example improving the hit rate may cause some tests @@ -82,9 +82,9 @@ static double test_cache(size_t megabytes, double load) * * Examples: * - * 1) at load 0.5, we expect a perfect hit rate, so we multiply by + * 1. at load 0.5, we expect a perfect hit rate, so we multiply by * 1.0 - * 2) at load 2.0, we expect to see half the entries, so a perfect hit rate + * 2. at load 2.0, we expect to see half the entries, so a perfect hit rate * would be 0.5. Therefore, if we see a hit rate of 0.4, 0.4*2.0 = 0.8 is the * normalized hit rate. * |