diff options
author | Tor Egge <Tor.Egge@broadpark.no> | 2020-05-20 14:21:27 +0200 |
---|---|---|
committer | Tor Egge <Tor.Egge@broadpark.no> | 2020-05-20 14:21:27 +0200 |
commit | 8ba1806c323fc8a2e1eef1ba2f9716fc4986ff87 (patch) | |
tree | 99476b8cd916cc43e0a9a6bc452db55836552813 /searchlib | |
parent | 1bc201d21999b1463b2123b44830351c40de57e8 (diff) |
Update class comments for PhraseSplitter and PhraseSplitterQueryEnv.
Diffstat (limited to 'searchlib')
-rw-r--r-- | searchlib/src/vespa/searchlib/fef/phrase_splitter_query_env.h | 17 | ||||
-rw-r--r-- | searchlib/src/vespa/searchlib/fef/phrasesplitter.h | 14 |
2 files changed, 13 insertions, 18 deletions
diff --git a/searchlib/src/vespa/searchlib/fef/phrase_splitter_query_env.h b/searchlib/src/vespa/searchlib/fef/phrase_splitter_query_env.h index 5a9c85b79db..7daa4d8f133 100644 --- a/searchlib/src/vespa/searchlib/fef/phrase_splitter_query_env.h +++ b/searchlib/src/vespa/searchlib/fef/phrase_splitter_query_env.h @@ -8,19 +8,14 @@ namespace search::fef { /** - * This class is used to split all phrase terms in a query environment - * into separate terms. New TermData and TermFieldMatchData objects - * are created for each splitted phrase term and managed by this - * class. Unmodified single terms are served from the query + * This class is used together with PhraseSplitter to split all phrase + * terms in a query environment into separate terms. New TermData + * objects are created for each splitted phrase term and managed by + * this class. Unmodified single terms are served from the query * environment and match data. * - * The TermFieldMatchData objects managed by this class are updated - * based on the TermFieldMatchData objects associated with the - * original phrase terms. Positions are adjusted with +1 for each term - * after the first one. - * - * Use this class if you want to handle a phrase term the same way as - * single terms. + * Use this class and PhraseSplitter class if you want to handle a + * phrase term the same way as single terms. **/ class PhraseSplitterQueryEnv : public IQueryEnvironment { diff --git a/searchlib/src/vespa/searchlib/fef/phrasesplitter.h b/searchlib/src/vespa/searchlib/fef/phrasesplitter.h index 8cec1d2f266..d0a5de6e8f2 100644 --- a/searchlib/src/vespa/searchlib/fef/phrasesplitter.h +++ b/searchlib/src/vespa/searchlib/fef/phrasesplitter.h @@ -10,19 +10,19 @@ namespace search::fef { class PhraseSplitterQueryEnv; /** - * This class is used to split all phrase terms in a query environment - * into separate terms. New TermData and TermFieldMatchData objects - * are created for each splitted phrase term and managed by this - * class. Unmodified single terms are served from the query - * environment and match data. + * This class is used together with PhraseSplitterQueryEnv to split + * all phrase terms in a query environment into separate terms. New + * TermFieldMatchData objects are created for each splitted phrase + * term and managed by this class. Unmodified single terms are served + * from the query environment and match data. * * The TermFieldMatchData objects managed by this class are updated * based on the TermFieldMatchData objects associated with the * original phrase terms. Positions are adjusted with +1 for each term * after the first one. * - * Use this class if you want to handle a phrase term the same way as - * single terms. + * Use this class and PhraseSplitterQueryEnv if you want to handle a + * phrase term the same way as single terms. **/ class PhraseSplitter { |