mirror of
https://github.com/QuasarApp/QuasarAppLib.git
synced 2025-05-03 21:19:42 +00:00
fix docs warnings
This commit is contained in:
parent
c25ec6e68f
commit
8615e4162d
@ -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<QString, QString> 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."}};
|
||||
|
@ -22,7 +22,7 @@ namespace QuasarAppUtils {
|
||||
|
||||
/**
|
||||
* @brief The Locales class for parese local files
|
||||
* @bold Example :
|
||||
* **Example :**
|
||||
* @code{cpp}
|
||||
* QuasarAppUtils::Locales::init();
|
||||
* @endcode
|
||||
|
11
params.h
11
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
|
||||
{
|
||||
|
@ -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
|
||||
*/
|
||||
|
Loading…
x
Reference in New Issue
Block a user