smallsolar
/
libkiwix
mirror of https://github.com/kiwix/libkiwix.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fixed some typos in the docs string

This commit is contained in:
Chris Li 2018-04-18 10:33:35 -04:00 committed by Matthieu Gautier
parent 1dd828e79c
commit 68665693c5
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/entry.h
View File

@ -50,7 +50,7 @@ class Entry
/** /**
* Construct an entry making reference to an zim article. * Construct an entry making reference to an zim article.
* *
* @param article * @param article a zim::Article object
*/ */
Entry(zim::Article article); Entry(zim::Article article);
virtual ~Entry() = default; virtual ~Entry() = default;

6
include/reader.h
View File

@ -280,7 +280,7 @@ class Reader
* Get the mimetype of a entry specified by a url. * Get the mimetype of a entry specified by a url.
* *
* @param[in] url the url of the entry. * @param[in] url the url of the entry.
* @param[out] mimetype the mimeType of the entry. * @param[out] mimeType the mimeType of the entry.
* @return True if the mimeType has been found. * @return True if the mimeType has been found.
*/ */
DEPRECATED bool getMimeTypeByUrl(const string& url, string& mimeType) const; DEPRECATED bool getMimeTypeByUrl(const string& url, string& mimeType) const;
@ -356,7 +356,7 @@ class Reader
* `getNextSuggestion` method. * `getNextSuggestion` method.
* *
* @param prefix The prefix to search. * @param prefix The prefix to search.
* @param suggestionCount How many suggestions to search for. * @param suggestionsCount How many suggestions to search for.
* @param reset If true, remove previous suggestions in the internal vector. * @param reset If true, remove previous suggestions in the internal vector.
* If false, add suggestions to the internal vector * If false, add suggestions to the internal vector
* (until internal vector size is suggestionCount (or no more * (until internal vector size is suggestionCount (or no more
@ -380,7 +380,7 @@ class Reader
* The internal vector will be reset. * The internal vector will be reset.
* *
* @param prefix The prefix to search for. * @param prefix The prefix to search for.
* @param suggestionCount How many suggestions to search for. * @param suggestionsCount How many suggestions to search for.
*/ */
bool searchSuggestionsSmart(const string& prefix, bool searchSuggestionsSmart(const string& prefix,
unsigned int suggestionsCount); unsigned int suggestionsCount);