From 3367faf2b86aedfa63980ee99699e1cc69253f70 Mon Sep 17 00:00:00 2001 From: Danny Robson Date: Sun, 4 Oct 2020 10:53:48 +1100 Subject: [PATCH] chunk/params: minimal documentation for members --- emory/chunk/params.hpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/emory/chunk/params.hpp b/emory/chunk/params.hpp index 2a970ca..f0bfed6 100644 --- a/emory/chunk/params.hpp +++ b/emory/chunk/params.hpp @@ -12,8 +12,11 @@ namespace emory::chunk { struct params { + /// The number of hash bits that must be zero to trigger detection. std::size_t bits; + /// The number of bytes history the hash uses. std::size_t window; + /// The minimum number of bytes for a matching region. std::ptrdiff_t minimum; }; }