From ebb1061e992d3be21244691cae16e73c2644dad4 Mon Sep 17 00:00:00 2001 From: tastytea Date: Thu, 8 Aug 2019 22:21:13 +0200 Subject: [PATCH] Escape Search in doxygen comments and replace vector with list. --- include/export/export.hpp | 8 ++++---- include/search.hpp | 19 +++++++++---------- include/sqlite.hpp | 2 +- 3 files changed, 14 insertions(+), 15 deletions(-) diff --git a/include/export/export.hpp b/include/export/export.hpp index 0d0cdd1..85615e7 100644 --- a/include/export/export.hpp +++ b/include/export/export.hpp @@ -40,9 +40,9 @@ namespace Export { 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. */ explicit ExportBase(const list &entries, @@ -60,9 +60,9 @@ namespace Export /*! * @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 sort_entries(list entries) const; diff --git a/include/search.hpp b/include/search.hpp index 1c34742..35bb4a0 100644 --- a/include/search.hpp +++ b/include/search.hpp @@ -29,7 +29,7 @@ namespace remwharead using std::vector; /*! - * @brief Search in database entries. + * @brief %Search in database entries. * * @since 0.7.0 * @@ -46,35 +46,34 @@ namespace remwharead explicit Search(const list &entries); /*! - * @brief Search in tags of database entries. + * @brief %Search in tags of database entries. * * 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? * - * @return Vector of matching Database::entry. + * @return List of matching Database::entry. * * @since 0.7.0 */ const list 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. * - * @param entries Vector of Database::entry to search. - * @param expression Search expression. + * @param expression %Search 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 */ const list search_all(string expression, - const bool is_re) const; + const bool is_re) const; private: const list _entries; diff --git a/include/sqlite.hpp b/include/sqlite.hpp index ea16e70..f33ba37 100644 --- a/include/sqlite.hpp +++ b/include/sqlite.hpp @@ -100,7 +100,7 @@ namespace remwharead 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 */