From 692106cb8d2f18d4cf95f4fc0b68773c2de990f2 Mon Sep 17 00:00:00 2001 From: Oleg-designer Date: Tue, 20 Apr 2021 12:26:53 +0300 Subject: [PATCH] ref #15 documentation correction --- Docs/QtUtils.md | 5 +++-- Docs/QuasarApp.md | 2 +- Docs/QuasarAppCITargets.md | 17 ++++++++++++----- Docs/ccache.md | 2 +- Docs/crossplatform.md | 2 +- README.md | 6 +++--- 6 files changed, 21 insertions(+), 13 deletions(-) diff --git a/Docs/QtUtils.md b/Docs/QtUtils.md index 3795a5b..30afabd 100644 --- a/Docs/QtUtils.md +++ b/Docs/QtUtils.md @@ -1,11 +1,12 @@ - -# QtUtils module description +# QtUtils module Module provides qt utils functions The module provides qt utils functions. This module contains some useful functions. Including provides translations functionality. --- + ## Translation + --- **prepareQM** (name sourceDir ts_files) - This function prepare translations for you projects. - name - This is a name of the translations target. diff --git a/Docs/QuasarApp.md b/Docs/QuasarApp.md index 3622891..dc607fe 100644 --- a/Docs/QuasarApp.md +++ b/Docs/QuasarApp.md @@ -1,5 +1,5 @@ -# QuasarApp module description +# QuasarApp module This is main cmake module of the QuasarApp group. All project of the QuasarApp group ust be use this module in own cmake rro directory. diff --git a/Docs/QuasarAppCITargets.md b/Docs/QuasarAppCITargets.md index 95bab70..226fc22 100644 --- a/Docs/QuasarAppCITargets.md +++ b/Docs/QuasarAppCITargets.md @@ -1,13 +1,14 @@ - -# QuasarAppCITargets module description - +# QuasarAppCITargets module + The library contains 2 methods type it is added methods and init methods. All inits method must be invoked before adds methods. If you change order then some add method will be ignored. This module implementation next cmake functions: --- + ## Testing + --- **addTestsArg** (name testExec arg) - Name target for test utility of your application. - name - Prefix for target (any word). @@ -21,7 +22,9 @@ This module implementation next cmake functions: **initTests** - Init main test target for testing all added tests, this method need to call before all invoiced addTests methods. --- - ## Deployment + + ## Deployment + --- **addDeploy** (name targets targetDir) - Add deploy target for deployed your application via CqtDeployer tool. - name - This is prefix of added subtarget (any word). @@ -55,7 +58,9 @@ This module implementation next cmake functions: **initDeploy** - Create a main deploy target for all addDeploy subtargets. This method need to call before invoiced of all addDeploy methods. --- + ## Release + --- **initRelease** - Сreate the general release target for all subtargets addRelease. This method need to call before invoice all addRelease methods. @@ -68,8 +73,10 @@ This module implementation next cmake functions: - targetDir - Path to target directory. --- + ## Dcumentation - --- + +--- **initDoc** - Create the general doc target for all subtargets addDoc. This method need to call before invoice all addDoc methods. **addDoc** (name doxygenFile) - Create subtargets for generate documentation of cpp code. diff --git a/Docs/ccache.md b/Docs/ccache.md index ef6be48..612f25d 100644 --- a/Docs/ccache.md +++ b/Docs/ccache.md @@ -1,5 +1,5 @@ -# ccache module description +# Ccache module This module adds support of the ccache. If you include this cmake file in the main cmakList file then your project will be use the ccache on to the compilator. \ No newline at end of file diff --git a/Docs/crossplatform.md b/Docs/crossplatform.md index a8e9a78..846ca25 100644 --- a/Docs/crossplatform.md +++ b/Docs/crossplatform.md @@ -1,5 +1,5 @@ -# crossplatform module description +# Crossplatform module This module include crossplatform toolchains by target platform. To select target platform set the TARGET_PLATFORM_TOOLCHAIN define. diff --git a/README.md b/README.md index 21ed47c..4e6a02e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # This is description of cmake modules was used in QasarApp project - + You can read all the information about the module you are interested in by clicking on the links below: - [QuasarAppCITargets](Docs/QuasarAppCITargets.md) - Module contains 2 type methods, it is added and init methods. - [QtUtils](Docs/QtUtils.md) - Module provides qt utils functions (the work with translation function and the include qt modules fucntion). - [QuasarApp](Docs/QuasarApp.md) - This is main cmake module of the QuasarApp group. -- [ccache](Docs/ccache.md) - Module for add support of the ccache. -- [crossplatform](Docs/crossplatform.md) - This module include crossplatform toolchains by target platform. \ No newline at end of file +- [Ccache](Docs/ccache.md) - Module for add support of the ccache. +- [Crossplatform](Docs/crossplatform.md) - This module include crossplatform toolchains by target platform. \ No newline at end of file