tastytea
/
remwharead
1
0
Fork 0
Code Issues 1 Pull Requests Releases 37 Activity

Escape Search in doxygen comments and replace vector with list.

This commit is contained in:
tastytea 2019-08-08 22:21:13 +02:00
parent 99869a6783
commit ebb1061e99
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
3 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/export/export.hpp
View File

@ -40,9 +40,9 @@ namespace Export
{ {
public: public:
/*! /*!
* @brief Export vector of Database::entry. * @brief Export list of Database::entry.
* *
* @param entries Vector of Database::entry to export. * @param entries List of Database::entry to export.
* @param out Output stream. * @param out Output stream.
*/ */
explicit ExportBase(const list<Database::entry> &entries, explicit ExportBase(const list<Database::entry> &entries,
@ -60,9 +60,9 @@ namespace Export
/*! /*!
* @brief Sort entries from newest to oldest. * @brief Sort entries from newest to oldest.
* *
* @param entries Vector of Database::entry to sort. * @param entries List of Database::entry to sort.
* *
* @return Sorted vector of Database::entry. * @return Sorted list of Database::entry.
*/ */
const list<Database::entry> const list<Database::entry>
sort_entries(list<Database::entry> entries) const; sort_entries(list<Database::entry> entries) const;

19
include/search.hpp
View File

@ -29,7 +29,7 @@ namespace remwharead
using std::vector; using std::vector;
/*! /*!
* @brief Search in database entries. * @brief %Search in database entries.
* *
* @since 0.7.0 * @since 0.7.0
* *
@ -46,35 +46,34 @@ namespace remwharead
explicit Search(const list<Database::entry> &entries); explicit Search(const list<Database::entry> &entries);
/*! /*!
* @brief Search in tags of database entries. * @brief %Search in tags of database entries.
* *
* Only matches whole tags, *Pill* does not match *Pillow*. * Only matches whole tags, *Pill* does not match *Pillow*.
* *
* @param expression Search expression. * @param expression %Search expression.
* @param is_re Is it a regular expression? * @param is_re Is it a regular expression?
* *
* @return Vector of matching Database::entry. * @return List of matching Database::entry.
* *
* @since 0.7.0 * @since 0.7.0
*/ */
const list<Database::entry> search_tags(string expression, const list<Database::entry> search_tags(string expression,
const bool is_re) const; const bool is_re) const;
/*! /*!
* @brief Search in full text of database entries. * @brief %Search in full text of database entries.
* *
* Searches in tags, title, description and full text. * Searches in tags, title, description and full text.
* *
* @param entries Vector of Database::entry to search. * @param expression %Search expression.
* @param expression Search expression.
* @param is_re Is it a regular expression? * @param is_re Is it a regular expression?
* *
* @return Vector of matching Database::entry. * @return List of matching Database::entry.
* *
* @since 0.7.0 * @since 0.7.0
*/ */
const list<Database::entry> search_all(string expression, const list<Database::entry> search_all(string expression,
const bool is_re) const; const bool is_re) const;
private: private:
const list<Database::entry> _entries; const list<Database::entry> _entries;

2
include/sqlite.hpp
View File

@ -100,7 +100,7 @@ namespace remwharead
void store(const entry &data) const; void store(const entry &data) const;
/*! /*!
* @brief Retrieve a vector of Database::entry from the database. * @brief Retrieve a list of Database::entry from the database.
* *
* @since 0.6.0 * @since 0.6.0
*/ */