From e5d26a4699054b6eb29e8a41d5ef1c9306d05f9b Mon Sep 17 00:00:00 2001 From: Matthieu Gautier Date: Wed, 12 Jan 2022 18:14:39 +0100 Subject: [PATCH] Deprecate `SearchRenderer` creation from a `Searcher`. --- include/search_renderer.h | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/include/search_renderer.h b/include/search_renderer.h index 5951ff8a7..5713ca2fe 100644 --- a/include/search_renderer.h +++ b/include/search_renderer.h @@ -35,12 +35,24 @@ class SearchRenderer { public: /** - * The default constructor. + * Construct a SearchRenderer from a Searcher. * - * @param humanReadableName The global zim's humanReadableName. - * Used to generate pagination links. + * This method is now deprecated. Construct the renderer from a + * `zim::SearchResultSet` + * + * @param searcher The `Searcher` to render. + * @param mapper The `NameMapper` to use to do the rendering. + */ + DEPRECATED SearchRenderer(Searcher* searcher, NameMapper* mapper); + + /** + * Construct a SearchRenderer from a SearchResultSet. + * + * @param srs The `SearchResultSet` to render. + * @param mapper The `NameMapper` to use to do the rendering. + * @param start The start offset used for the srs. + * @param estimatedResultCount The estimatedResultCount of the whole search */ - SearchRenderer(Searcher* searcher, NameMapper* mapper); SearchRenderer(zim::SearchResultSet srs, NameMapper* mapper, unsigned int start, unsigned int estimatedResultCount);