Add comment describing semantics of return value from

SlimeFillerFilter::get_filter().

1 files changed, 5 insertions, 1 deletions

diff --git a/searchsummary/src/vespa/searchsummary/docsummary/slime_filler_filter.h b/searchsummary/src/vespa/searchsummary/docsummary/slime_filler_filter.h
index 8f2c5dea392..ba7ba6fe159 100644
--- a/searchsummary/src/vespa/searchsummary/docsummary/slime_filler_filter.h
+++ b/searchsummary/src/vespa/searchsummary/docsummary/slime_filler_filter.h
@@ -17,7 +17,11 @@ class SlimeFillerFilter {
 public:
     SlimeFillerFilter();
     ~SlimeFillerFilter();
-    static std::optional<const SlimeFillerFilter*> get_filter(const SlimeFillerFilter*, vespalib::stringref field_name);
+    /*
+     * If field is blocked by the filter then the return value is not set,
+     * otherwise it is set to the filter for the next level.
+     */
+    static std::optional<const SlimeFillerFilter*> get_filter(const SlimeFillerFilter* filter, vespalib::stringref field_name);
     bool empty() const;
     SlimeFillerFilter& add(vespalib::stringref field_path);
 };