From 8615e4162de9deecf90017bf9fc270682d0ad4c4 Mon Sep 17 00:00:00 2001 From: EndrII Date: Mon, 26 Apr 2021 12:01:08 +0300 Subject: [PATCH] fix docs warnings --- helpdata.h | 8 ++++---- locales.h | 2 +- params.h | 11 +++++++---- settings.h | 2 +- 4 files changed, 13 insertions(+), 10 deletions(-) diff --git a/helpdata.h b/helpdata.h index 195f251..87611cb 100644 --- a/helpdata.h +++ b/helpdata.h @@ -18,10 +18,10 @@ namespace QuasarAppUtils{ */ namespace Help { /** - * @brief Options this is list of @bold key-descriptions pairs of help. - * The @bold key is name of the available argument and @bold description is description of the available argument. + * @brief Options this is list of **key-descriptions** pairs of help. + * The **key** is name of the available argument and **description** is description of the available argument. * - * @bold Example: + * **Example**: * * @code{cpp} * Options myOptionsList = {{"argument1", "This is test argumetn1 of my application."}, @@ -34,7 +34,7 @@ typedef QMultiMap Options; /** * @brief Section This is list of the help Sections. The one section it is Title of the section and Help::Options list. * - * @bold Example: + * **Example:** * @code{cpp} * Options myOptionsList = {{"argument1", "This is test argumetn1 of my application."}, * {"argument1", "This is test argumetn1 of my application."}}; diff --git a/locales.h b/locales.h index 71a82e6..7102ed4 100644 --- a/locales.h +++ b/locales.h @@ -22,7 +22,7 @@ namespace QuasarAppUtils { /** * @brief The Locales class for parese local files - * @bold Example : + * **Example :** * @code{cpp} * QuasarAppUtils::Locales::init(); * @endcode diff --git a/params.h b/params.h index 89b1984..5fbcb24 100644 --- a/params.h +++ b/params.h @@ -19,13 +19,13 @@ namespace QuasarAppUtils { * @brief The VerboseLvl enum uses for sets log level. */ enum VerboseLvl { - /// General information. This logs will marked as a @bold Info and printing always. + /// General information. This logs will marked as a **Info** and printing always. Info = 0x0, - /// Error message. This logs will marked as a @bold Error and printing if the verbose lvl >= 1 + /// Error message. This logs will marked as a **Error** and printing if the verbose lvl >= 1 Error = 0x1, - /// Warning message. This logs will marked as a @bold Warning and printing if the verbose lvl >= 2 + /// Warning message. This logs will marked as a **Warning** and printing if the verbose lvl >= 2 Warning = 0x2, - /// Debug message. This logs will marked as a @bold Debug and printing if the verbose lvl >= 3 + /// Debug message. This logs will marked as a **Debug** and printing if the verbose lvl >= 3 Debug = 0x3, }; @@ -40,6 +40,9 @@ enum VerboseLvl { /** * @brief The Params class Contains fonctions for working with input arguments and logs. + * This Class support next comandline arguments. + * * **-verbose** (level 1 - 3) Shows debug log + * * **-fileLog** (path to file) Sets path of log file. Default it is path to executable file with suffix '.log' */ class QUASARAPPSHARED_EXPORT Params { diff --git a/settings.h b/settings.h index b2674f1..a9ad5c8 100644 --- a/settings.h +++ b/settings.h @@ -77,7 +77,7 @@ public: public slots: /** - * @brief setValue This slot sets new value for a @key setting + * @brief setValue This slot sets new value for a @a key setting * @param key This is name of the changed setting. * @param value This is a new value of the setting */