diff --git a/helpdata.h b/helpdata.h index 71c7287..ef88bc2 100644 --- a/helpdata.h +++ b/helpdata.h @@ -15,39 +15,39 @@ namespace QuasarAppUtils{ namespace Help { /** - * @brief Options - this is list of key - descriptions pairs of help. + * @brief Options this is list of key - descriptions pairs of help. */ typedef QMultiMap Options; /** - * @brief Charters = ths is list of charters. + * @brief Charters ths is list of charters. */ typedef QMultiMap Charters; int width(); /** - * @brief print - line of help - * @param key - option name - * @param value - description of option + * @brief print Line of help. + * @param key Option name. + * @param value Description of option. */ void QUASARAPPSHARED_EXPORT print(const QString& key, const QString& value, int keyLength); /** - * @brief print = help Charter - * @param charter - charter of help + * @brief print Help Charter. + * @param charter Charter of help. */ void QUASARAPPSHARED_EXPORT print(const Options& charter); /** - * @brief print - all help - * @param help - help for printing + * @brief print All help. + * @param help Help for printing. */ void QUASARAPPSHARED_EXPORT print(const Charters& help); /** - * @brief setLineLength - sets new length of helps line - * @param newLength - new size + * @brief setLineLength sets new length of helps line. + * @param newLength New size. */ void QUASARAPPSHARED_EXPORT setLineLength(int newLength); } diff --git a/locales.h b/locales.h index b22ba11..5dbba9e 100644 --- a/locales.h +++ b/locales.h @@ -40,10 +40,10 @@ public: static bool setLocale(const QLocale &locale); /** - * @brief init This method initialize translation of applictaion - * @param locale - see info about QLocale - * @param location - path to folder with qm files. example (:/tr) - * @return return true if locale set for application + * @brief init This method initialize translation of applictaion. + * @param locale See info about QLocale. + * @param location Path to folder with qm files. example (:/tr). + * @return return true if locale set for application. */ static bool init(const QLocale &locale = QLocale::system(), const QSet & location = {}); @@ -55,7 +55,7 @@ public: signals: /** - * @brief sigTranslationChanged - emited when set new locale for application. + * @brief sigTranslationChanged Emited when set new locale for application. */ void sigTranslationChanged(); diff --git a/params.h b/params.h index 4b63f73..4db35eb 100644 --- a/params.h +++ b/params.h @@ -15,7 +15,7 @@ namespace QuasarAppUtils { /** - * @brief The Params class for parese app params + * @brief The Params class for parese app params. */ enum VerboseLvl { @@ -51,69 +51,69 @@ public: Params() = delete; /** - * @brief parseParams - parase input data of started application - * @param argc - count of arguments - * @param argv - arrat of arguments - * @return true if all arguments read else false + * @brief parseParams Parse input data of started application. + * @param argc Count of arguments. + * @param argv Array of arguments. + * @return true if all arguments read else false. */ static bool parseParams(const int argc, const char *argv[]); static bool parseParams(int argc, char *argv[]); /** - * @brief parseParams - parase input data of started application - * @param params - arguments - * @return true if all arguments read else false + * @brief parseParams Parse input data of started application. + * @param paramsArray Arguments. + * @return true if all arguments read else false. */ static bool parseParams(const QStringList& paramsArray); /** - * @brief getArg - get string value of key + * @brief getArg Get string value of key. * @param key This is key of the parameter. - * @param def - default value - * @return string value of argument + * @param def Default value. + * @return string value of argument. */ static QString getArg(const QString& key, const QString &def = {}); /** - * @brief setArg - sets value of key - * @param key This is new value of the @a key + * @brief setArg Sets value of key. + * @param key This is new value of the @a key. */ static void setArg(const QString& key, const QString& val); /** - * @brief setArg - sets boolean value of key + * @brief setArg Sets boolean value of key. * @param key - * @param enable - new value of key + * @param enable New value of key. */ static void setEnable(const QString& key, bool enable); /** - * @brief isEndable - check if enable argument of key + * @brief isEndable Check if enable argument of key. * @param key - * @return true if argument enabled + * @return true if argument enabled. */ static bool isEndable(const QString& key); /** - * @brief log - print text on console if the flag "vergose" is enabled - * @param log - printed text + * @brief log Print text on console if the flag "vergose" is enabled. + * @param log Printed textP. */ - static void log(const QString& log, VerboseLvl vLvl = VerboseLvl::Debug); + static void log(const QStrinP& log, VerboseLvl vLvl = VerboseLvl::Debug); /** * @brief getparamsHelp - * @return help string of default params + * @return help string of default params. */ static Help::Charters getparamsHelp(); /** - * @brief showHelp - show all strings of help + * @brief showHelp Show all strings of help. * @param help */ static void showHelp(const QStringList& help); /** - * @brief showHelp - show structe of help value + * @brief showHelp Show structe of help value. * @param help */ static void showHelp(const Help::Charters& help); @@ -138,30 +138,30 @@ public: /** - * @brief size This method return size of all params array - * @return size of all params array + * @brief size This method return size of all params array. + * @return size Of all params array. */ static int size(); /** - * @brief customParamasSize This method return a size of params entered in conosole - * @return size of params entered in conosole + * @brief customParamasSize This method return a size of params entered in conosole. + * @return size of params entered in conosole. */ static int customParamasSize(); /** - * @brief showHelp - show base help section of QuasarAppLib + * @brief showHelp - show base help section of QuasarAppLib. */ static void showHelp(); /** - * @brief getUserParamsMap - * @return QVariantMap with user params + * @brief getUserParamsMap. + * @return QVariantMap With user params. */ static QMap getUserParamsMap(); /** - * @brief clearParsedData - this method clear allparsed data. + * @brief clearParsedData - This method clear allparsed data. */ static void clearParsedData(); diff --git a/quasarapp.h b/quasarapp.h index d0fa7af..8082590 100644 --- a/quasarapp.h +++ b/quasarapp.h @@ -15,8 +15,8 @@ /** * @brief The QuasaraAppUtils class - * this lib include base functions for the all applications of QuasarApp group. - * all methods of the Quasar AppUtils is static + * This lib include base functions for the all applications of QuasarApp group. + * All methods of the Quasar AppUtils is static. */ namespace QuasarAppUtils{