mirror of
https://github.com/QuasarApp/CMake.git
synced 2025-04-26 09:44:41 +00:00
ref #15 documentation correction
This commit is contained in:
parent
be90ace88a
commit
692106cb8d
@ -1,11 +1,12 @@
|
|||||||
|
# QtUtils module
|
||||||
# QtUtils module description
|
|
||||||
|
|
||||||
Module provides qt utils functions
|
Module provides qt utils functions
|
||||||
The module provides qt utils functions. This module contains some useful functions. Including provides translations functionality.
|
The module provides qt utils functions. This module contains some useful functions. Including provides translations functionality.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Translation
|
## Translation
|
||||||
|
|
||||||
---
|
---
|
||||||
**prepareQM** (name sourceDir ts_files) - This function prepare translations for you projects.
|
**prepareQM** (name sourceDir ts_files) - This function prepare translations for you projects.
|
||||||
- name - This is a name of the translations target.
|
- name - This is a name of the translations target.
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
|
|
||||||
# QuasarApp module description
|
# QuasarApp module
|
||||||
|
|
||||||
This is main cmake module of the QuasarApp group.
|
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.
|
All project of the QuasarApp group ust be use this module in own cmake rro directory.
|
||||||
|
@ -1,13 +1,14 @@
|
|||||||
|
# QuasarAppCITargets module
|
||||||
# QuasarAppCITargets module description
|
|
||||||
|
|
||||||
The library contains 2 methods type it is added methods and init methods.
|
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.
|
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:
|
This module implementation next cmake functions:
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
---
|
---
|
||||||
**addTestsArg** (name testExec arg) - Name target for test utility of your application.
|
**addTestsArg** (name testExec arg) - Name target for test utility of your application.
|
||||||
- name - Prefix for target (any word).
|
- 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.
|
**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.
|
**addDeploy** (name targets targetDir) - Add deploy target for deployed your application via CqtDeployer tool.
|
||||||
- name - This is prefix of added subtarget (any word).
|
- 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.
|
**initDeploy** - Create a main deploy target for all addDeploy subtargets. This method need to call before invoiced of all addDeploy methods.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Release
|
## Release
|
||||||
|
|
||||||
---
|
---
|
||||||
**initRelease** - Сreate the general release target for all subtargets addRelease. This method need to call before invoice all addRelease methods.
|
**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.
|
- targetDir - Path to target directory.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Dcumentation
|
## Dcumentation
|
||||||
---
|
|
||||||
|
---
|
||||||
**initDoc** - Create the general doc target for all subtargets addDoc. This method need to call before invoice all addDoc methods.
|
**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.
|
**addDoc** (name doxygenFile) - Create subtargets for generate documentation of cpp code.
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
|
|
||||||
# ccache module description
|
# Ccache module
|
||||||
|
|
||||||
This module adds support of the ccache.
|
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.
|
If you include this cmake file in the main cmakList file then your project will be use the ccache on to the compilator.
|
@ -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.
|
This module include crossplatform toolchains by target platform. To select target platform set the TARGET_PLATFORM_TOOLCHAIN define.
|
||||||
|
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
# This is description of cmake modules was used in QasarApp project
|
# 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:
|
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.
|
- [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).
|
- [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.
|
- [QuasarApp](Docs/QuasarApp.md) - This is main cmake module of the QuasarApp group.
|
||||||
- [ccache](Docs/ccache.md) - Module for add support of the ccache.
|
- [Ccache](Docs/ccache.md) - Module for add support of the ccache.
|
||||||
- [crossplatform](Docs/crossplatform.md) - This module include crossplatform toolchains by target platform.
|
- [Crossplatform](Docs/crossplatform.md) - This module include crossplatform toolchains by target platform.
|
Loading…
x
Reference in New Issue
Block a user