Cosmetic changes in the Documentation.
This commit is contained in:
parent
38e8e1dc81
commit
998cc32546
|
@ -43,16 +43,22 @@ namespace Export
|
|||
|
||||
//! Replace strings in text.
|
||||
const string replace(string text, const replacemap &replacements) const;
|
||||
|
||||
//! Replaces characters in tags that asciidoctor doesn't like.
|
||||
const string replace_in_tag(const string &text) const;
|
||||
|
||||
//! Replaces characters in title that asciidoctor doesn't like.
|
||||
const string replace_in_title(const string &text) const;
|
||||
|
||||
//! Replaces characters in URI that asciidoctor doesn't like.
|
||||
const string replace_in_uri(const string &text) const;
|
||||
|
||||
//! Print things sorted by tag.
|
||||
void print_tags(const tagmap &tags) const;
|
||||
|
||||
//! Get ISO-8601 day from Database::entry.
|
||||
const string get_day(const Database::entry &entry) const;
|
||||
|
||||
//! Get ISO-8601 time from Database::entry.
|
||||
const string get_time(const Database::entry &entry) const;
|
||||
};
|
||||
|
|
|
@ -34,16 +34,16 @@ namespace Export
|
|||
{
|
||||
public:
|
||||
/*!
|
||||
* @brief Export vector of Database::entry.
|
||||
* @brief Export vector of Database::entry.
|
||||
*
|
||||
* @param entries Vector of Database::entry to export.
|
||||
* @param out Output stream.
|
||||
* @param entries Vector of Database::entry to export.
|
||||
* @param out Output stream.
|
||||
*/
|
||||
explicit ExportBase(const vector<Database::entry> &entries,
|
||||
ostream &out = cout);
|
||||
|
||||
/*!
|
||||
* @brief Print output to std::ostream.
|
||||
* @brief Print output to std::ostream.
|
||||
*/
|
||||
virtual void print() const = 0;
|
||||
|
||||
|
@ -52,11 +52,11 @@ namespace Export
|
|||
ostream &_out;
|
||||
|
||||
/*!
|
||||
* @brief Sort entries from newest to oldest.
|
||||
* @brief Sort entries from newest to oldest.
|
||||
*
|
||||
* @param entries Vector of Database::entry to sort.
|
||||
* @param entries Vector of Database::entry to sort.
|
||||
*
|
||||
* @return Sorted vector of Database::entry.
|
||||
* @return Sorted vector of Database::entry.
|
||||
*/
|
||||
const vector<Database::entry>
|
||||
sort_entries(vector<Database::entry> entries) const;
|
||||
|
|
|
@ -29,12 +29,12 @@ namespace remwharead
|
|||
using std::string;
|
||||
|
||||
/*!
|
||||
* @brief Split expression in subexpressions.
|
||||
* @brief Split expression in subexpressions.
|
||||
*
|
||||
* First it splits at `OR` or `||`, then it splits the subexpressions at
|
||||
* `AND` or `&&`. The first vector contains all tags before the first `OR`.
|
||||
*
|
||||
* @return Vector of `OR`-vectors of `AND`-tags.
|
||||
* @return Vector of `OR`-vectors of `AND`-tags.
|
||||
*/
|
||||
const vector<vector<string>> parse_expression(string expression);
|
||||
|
||||
|
@ -42,30 +42,30 @@ namespace remwharead
|
|||
const string to_lowercase(const string &str);
|
||||
|
||||
/*!
|
||||
* @brief Search in tags of database entries.
|
||||
* @brief Search in tags of database entries.
|
||||
*
|
||||
* Only matches whole tags, *Pill* does not match *Pillow*.
|
||||
*
|
||||
* @param entries Vector of Database::entry to search.
|
||||
* @param expression Search expression.
|
||||
* @param is_re Is it a regular expression?
|
||||
* @param entries Vector of Database::entry to search.
|
||||
* @param expression Search expression.
|
||||
* @param is_re Is it a regular expression?
|
||||
*
|
||||
* @return Vector of matching Database::entry.
|
||||
* @return Vector of matching Database::entry.
|
||||
*/
|
||||
const vector<Database::entry>
|
||||
search_tags(const vector<Database::entry> &entries, string expression,
|
||||
const bool is_re);
|
||||
|
||||
/*!
|
||||
* @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 is_re Is it a regular expression?
|
||||
* @param entries Vector of Database::entry to search.
|
||||
* @param expression Search expression.
|
||||
* @param is_re Is it a regular expression?
|
||||
*
|
||||
* @return Vector of matching Database::entry.
|
||||
* @return Vector of matching Database::entry.
|
||||
*/
|
||||
const vector<Database::entry>
|
||||
search_all(const vector<Database::entry> &entries, string expression,
|
||||
|
|
|
@ -23,7 +23,6 @@
|
|||
#include <vector>
|
||||
#include <chrono>
|
||||
#include <sqlite/connection.hpp>
|
||||
#include "types.hpp"
|
||||
|
||||
namespace remwharead
|
||||
{
|
||||
|
|
|
@ -29,12 +29,12 @@ namespace remwharead
|
|||
using time_point = system_clock::time_point;
|
||||
|
||||
/*!
|
||||
* @brief Convert ISO 8601 or SQLite time-string to time_point.
|
||||
* @brief Convert ISO 8601 or SQLite time-string to time_point.
|
||||
*
|
||||
* The SQLite format is *YY-MM-DD hh:mm:ss* instead of *YY-MM-DDThh:mm:ss*.
|
||||
*
|
||||
* @param strtime Time string in ISO 8601 or SQLite format.
|
||||
* @param sqlite Is the string in SQLite format?
|
||||
* @param strtime Time string in ISO 8601 or SQLite format.
|
||||
* @param sqlite Is the string in SQLite format?
|
||||
*/
|
||||
const time_point string_to_timepoint(const string &strtime,
|
||||
bool sqlite = false);
|
||||
|
@ -44,8 +44,8 @@ namespace remwharead
|
|||
*
|
||||
* The SQLite format is *YY-MM-DD hh:mm:ss* instead of *YY-MM-DDThh:mm:ss*.
|
||||
*
|
||||
* @param time_point The std::chrono::system_clock::time_point.
|
||||
* @param sqlite Is the string in SQLite format?
|
||||
* @param time_point The std::chrono::system_clock::time_point.
|
||||
* @param sqlite Is the string in SQLite format?
|
||||
*/
|
||||
const string timepoint_to_string(const time_point &tp, bool sqlite = false);
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue