diff options
author | Henning Baldersheim <balder@yahoo-inc.com> | 2017-03-21 15:32:48 +0100 |
---|---|---|
committer | Henning Baldersheim <balder@yahoo-inc.com> | 2017-03-21 15:32:48 +0100 |
commit | 307a3d3801e445ed6c13d90e179e62bab30cd5c8 (patch) | |
tree | 5f376104aa75733b9220ebb6fbf7c9abdd8ba01d /streamingvisitors | |
parent | 97cb260cbe24d644f477362fe1de9407fc53d6c9 (diff) |
Update comments with lifetime assumptions.
Diffstat (limited to 'streamingvisitors')
-rw-r--r-- | streamingvisitors/src/vespa/searchvisitor/hitcollector.h | 4 | ||||
-rw-r--r-- | streamingvisitors/src/vespa/searchvisitor/searchvisitor.h | 4 |
2 files changed, 4 insertions, 4 deletions
diff --git a/streamingvisitors/src/vespa/searchvisitor/hitcollector.h b/streamingvisitors/src/vespa/searchvisitor/hitcollector.h index b8b35f992fc..12503640cbb 100644 --- a/streamingvisitors/src/vespa/searchvisitor/hitcollector.h +++ b/streamingvisitors/src/vespa/searchvisitor/hitcollector.h @@ -95,7 +95,7 @@ public: * If you add a NULL document you should not use getDocSum() or fillSearchResult(), * as these functions expect valid documents. * - * @param doc The document that is a hit. + * @param doc The document that is a hit. Must be kept alive on the outside. * @param data The match data for the hit. * @return true if the document was added to the heap **/ @@ -107,7 +107,7 @@ public: * If you add a NULL document you should not use getDocSum() or fillSearchResult(), * as these functions expect valid documents. * - * @param doc The document that is a hit. + * @param doc The document that is a hit. Must be kept alive on the outside. * @param data The match data for the hit. * @param sortData The buffer of the sortdata. * @param sortDataLen The length of the sortdata. diff --git a/streamingvisitors/src/vespa/searchvisitor/searchvisitor.h b/streamingvisitors/src/vespa/searchvisitor/searchvisitor.h index b6240fb5d8c..672a420e55a 100644 --- a/streamingvisitors/src/vespa/searchvisitor/searchvisitor.h +++ b/streamingvisitors/src/vespa/searchvisitor/searchvisitor.h @@ -184,13 +184,13 @@ private: * @param hasSorting whether the search result should be sorted. * @param visitor the search visitor. * @param tmpSortBuffer the sort buffer containing the sort data. - * @param documentId the document id of the document to collect. + * @param document the document to collect. Must be kept alive on the outside. * @return true if the document was added to the heap **/ bool collectMatchedDocument(bool hasSorting, SearchVisitor & visitor, const std::vector<char> & tmpSortBuffer, - const vsm::StorageDocument * documentId); + const vsm::StorageDocument * document); /** * Callback function that is called when visiting is completed. * Perform second phase ranking and calculate summary features / rank features if asked for. |