diff options
author | Tor Egge <Tor.Egge@broadpark.no> | 2020-05-13 14:27:31 +0200 |
---|---|---|
committer | Tor Egge <Tor.Egge@broadpark.no> | 2020-05-13 14:27:31 +0200 |
commit | 9b7e93e134341de8599c69a2922d6bc6e5b0febb (patch) | |
tree | 53881741dd8da014eee97d4b77af92a283ef0134 /searchcore | |
parent | 63bcb0afede7fec1614e2ac396767b8e4b8bb2c9 (diff) |
Update class comments.
Diffstat (limited to 'searchcore')
3 files changed, 7 insertions, 4 deletions
diff --git a/searchcore/src/vespa/searchcore/proton/attribute/attribute_usage_sampler_context.h b/searchcore/src/vespa/searchcore/proton/attribute/attribute_usage_sampler_context.h index b5693aef1bc..6f33ac483c1 100644 --- a/searchcore/src/vespa/searchcore/proton/attribute/attribute_usage_sampler_context.h +++ b/searchcore/src/vespa/searchcore/proton/attribute/attribute_usage_sampler_context.h @@ -12,8 +12,9 @@ class AttributeConfigInspector; class TransientMemoryUsageProvider; /* - * Context for sampling attribute usage stats. When instance is - * destroyed, the aggregated stats is passed on to attribute usage filter. + * Context for sampling attribute usage stats and transient memory usage. + * When instance is destroyed, the aggregated stats is passed on to + * attribute usage filter and the transient memory usage provider. */ class AttributeUsageSamplerContext { diff --git a/searchcore/src/vespa/searchcore/proton/common/i_transient_memory_usage_provider.h b/searchcore/src/vespa/searchcore/proton/common/i_transient_memory_usage_provider.h index e00ccfd3c27..cd87150195c 100644 --- a/searchcore/src/vespa/searchcore/proton/common/i_transient_memory_usage_provider.h +++ b/searchcore/src/vespa/searchcore/proton/common/i_transient_memory_usage_provider.h @@ -8,7 +8,8 @@ namespace proton { /* * Interface class providing transient memory usage, e.g. extra memory needed - * for loading or saving an attribute vector. + * for loading or saving an attribute vector. It provides an aggregated view + * over several components (e.g. all attribute vectors for a document type). */ class ITransientMemoryUsageProvider { public: diff --git a/searchcore/src/vespa/searchcore/proton/common/transient_memory_usage_provider.h b/searchcore/src/vespa/searchcore/proton/common/transient_memory_usage_provider.h index 42c6933677a..8cda4278ad8 100644 --- a/searchcore/src/vespa/searchcore/proton/common/transient_memory_usage_provider.h +++ b/searchcore/src/vespa/searchcore/proton/common/transient_memory_usage_provider.h @@ -10,7 +10,8 @@ namespace proton { /* * Class providing transient memory usage, e.g. extra memory needed - * for loading or saving an attribute vector. + * for loading or saving an attribute vector. It provides an aggregated view + * over several components (e.g. all attribute vectors for a document type). */ class TransientMemoryUsageProvider : public ITransientMemoryUsageProvider { std::atomic<size_t> _transient_memory_usage; |