aboutsummaryrefslogtreecommitdiffstats
path: root/searchsummary
diff options
context:
space:
mode:
authorTor Egge <Tor.Egge@online.no>2022-07-08 11:19:50 +0200
committerTor Egge <Tor.Egge@online.no>2022-07-08 11:19:50 +0200
commit5043e60e542f4b1fcbc5f4a7b4c9ff2ab26442c7 (patch)
tree753533928b8f9d5086ff1dfe6041999cd656c4b8 /searchsummary
parentdbd132133357a0354933df5800bdb5ec7b26088d (diff)
Add class comments.
Diffstat (limited to 'searchsummary')
-rw-r--r--searchsummary/src/vespa/searchsummary/docsummary/copy_dfw.h3
-rw-r--r--searchsummary/src/vespa/searchsummary/docsummary/empty_dfw.h3
-rw-r--r--searchsummary/src/vespa/searchsummary/docsummary/simple_dfw.h4
3 files changed, 10 insertions, 0 deletions
diff --git a/searchsummary/src/vespa/searchsummary/docsummary/copy_dfw.h b/searchsummary/src/vespa/searchsummary/docsummary/copy_dfw.h
index 40427e0e458..dab7417f60a 100644
--- a/searchsummary/src/vespa/searchsummary/docsummary/copy_dfw.h
+++ b/searchsummary/src/vespa/searchsummary/docsummary/copy_dfw.h
@@ -8,6 +8,9 @@ namespace search::docsummary {
class ResultConfig;
+/*
+ * Class for writing document summaries with content from another field.
+ */
class CopyDFW : public DocsumFieldWriter
{
private:
diff --git a/searchsummary/src/vespa/searchsummary/docsummary/empty_dfw.h b/searchsummary/src/vespa/searchsummary/docsummary/empty_dfw.h
index c842e1416db..d43eed8e9c6 100644
--- a/searchsummary/src/vespa/searchsummary/docsummary/empty_dfw.h
+++ b/searchsummary/src/vespa/searchsummary/docsummary/empty_dfw.h
@@ -6,6 +6,9 @@
namespace search::docsummary {
+/*
+ * Class for writing empty document summaries.
+ */
class EmptyDFW : public SimpleDFW
{
public:
diff --git a/searchsummary/src/vespa/searchsummary/docsummary/simple_dfw.h b/searchsummary/src/vespa/searchsummary/docsummary/simple_dfw.h
index 521bae6497b..abebb7de2b8 100644
--- a/searchsummary/src/vespa/searchsummary/docsummary/simple_dfw.h
+++ b/searchsummary/src/vespa/searchsummary/docsummary/simple_dfw.h
@@ -6,6 +6,10 @@
namespace search::docsummary {
+/*
+ * Abstract class for writing document summaries that don't need
+ * access to a document retrieved from IDocsumStore.
+ */
class SimpleDFW : public DocsumFieldWriter
{
public: