smallsolar/libkiwix
1
0
Fork 0
mirror of https://github.com/kiwix/libkiwix.git synced 2025-06-26 10:11:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Readd a SearchRenderer constructor without Library argument.

Browse Source 
Adding the library argument breaks the API. It is better to add
another constructor to not have to create another major version.
This commit is contained in:
Matthieu Gautier
2022-02-25 15:10:36 +01:00
parent a11abcf480
commit ec18eb40ea
2 changed files with 21 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
include/search_renderer.h
View File

@ -49,10 +49,24 @@ class SearchRenderer
/**
* Construct a SearchRenderer from a SearchResultSet.
*
* The constructed version of the SearchRendered will not introduce
* the book name for each result. It is better to use the another constructor
* with a Library pointer to have a better html page.
*
* @param srs The `SearchResultSet` to render.
* @param mapper The `NameMapper` to use to do the rendering.
* @param library The `Library` to use to look up book details for search
* results
* @param start The start offset used for the srs.
* @param estimatedResultCount The estimatedResultCount of the whole search
*/
SearchRenderer(zim::SearchResultSet srs, NameMapper* mapper,
unsigned int start, unsigned int estimatedResultCount);
/**
* Construct a SearchRenderer from a SearchResultSet.
*
* @param srs The `SearchResultSet` to render.
* @param mapper The `NameMapper` to use to do the rendering.
* @param library The `Library` to use to look up book details for search results.
* @param start The start offset used for the srs.
* @param estimatedResultCount The estimatedResultCount of the whole search
*/