4
0
mirror of https://github.com/QuasarApp/CMake.git synced 2025-04-30 19:54:44 +00:00

ref QasarAppCITargets.cmake grammar correction

This commit is contained in:
Oleg-designer 2021-03-25 14:29:26 +03:00
parent 73daf8b2b8
commit d55412ed2b

@ -6,77 +6,77 @@
# #
# This module implementation next cmake cunctions : # This module implementation next cmake functions :
# #
# This library contains 2 methods type it is Addd methods and Init Methods # The library contains 2 methods type it is Added methods and init methods.
# All inits method must be invoked befor 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.
# #
# ***Testing*** # ***Testing***
# addTestsArg( name testExec arg ) // name target for test utiliry of your application # addTestsArg( name testExec arg ) // Name target for test utility of your application.
# - name - prefix for taget (any word) # - name - Prefix for target (any word).
# - testExec - name of tests utility (without extensions) # - testExec - Name of tests utility (without extensions).
# - arg - arguments fot testExec # - arg - Arguments for testExec.
# #
# addTests (name testExec )// name target for test utiliry of your application (without arguments) # addTests (name testExec )// Name target for test utility of your application (without arguments).
# - name - prefix for taget (any word) # - name - Prefix for target (any word).
# - testExec - name of tests utility (without extensions) # - testExec - Name of tests utility (without extensions).
# #
# initTests - init main test target for tessting all added tests, this method need to call befor all invoced addTests methods. # initTests - Init main test target for tessting 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).
# - targets - this is list of cqtdeployer targets see cqtdeployer help https://github.com/QuasarApp/CQtDeployer/wiki/Options (-bin) # - targets - This is list of CQtDeployer targets see CQtDeployer help https://github.com/QuasarApp/CQtDeployer/wiki/Options (-bin).
# - targetDir - this is target directory see option targetDir of cqtdeployer help https://github.com/QuasarApp/CQtDeployer/wiki/Options (-targetDir) # - targetDir - This is target directory see option targetDir of CQtDeployer help https://github.com/QuasarApp/CQtDeployer/wiki/Options (-targetDir).
# #
# addDeployFromFile(name) // some as initDeploy but use CQtDeployer.json for configuration. # addDeployFromFile(name) // Some as initDeploy, but use CQtDeployer.json for configuration.
# - name - this is prefix of added subtarget (any word) # - name - This is prefix of added subtarget (any word).
# #
# addDeployFromCustomFile(name file) // some as initDeploy but use custo path for deployment file for configuration. # addDeployFromCustomFile(name file) // Some as initDeploy, but use custom path for deployment file for configuration.
# - name - this is prefix of added subtarget (any word) # - name - This is prefix of added subtarget (any word).
# - file - this is path to config file of cqtdeployer # - file - This is path to config file of cqtdeployer.
# #
# addDeploySnap(name targetDir) // add to deploy step substeps for create a snap package # addDeploySnap(name targetDir) // Add to deploy step substeps for create a snap package.
# - name - this is prefix of added subtarget (any word) # - name - This is prefix of added subtarget (any word).
# - targetDir - distanation direcroty for snap files # - targetDir - Destanation direcroty for snap files.
# #
# addDeployQIF(name sourceDir targetDir config) // add to deploy step substeps for create Qt Install FrameWork Installer # addDeployQIF(name sourceDir targetDir config) // Add to deploy step substeps for create Qt Install FrameWork Installer.
# - name - this is prefix of added subtarget (any word) # - name - This is prefix of added subtarget (any word).
# - location for created installer # - location for created installer.
# - sourceDir - path to folder with qif template # - sourceDir - Path to folder with qif template.
# - config - path to config file of qif template # - config - Path to config file of qif template.
# #
# addDeployAPK(name input aliase keystore keystorePass targetDir) // add subtargets of deploy setep for create signed android apk file # addDeployAPK(name input aliase keystore keystorePass targetDir) // Add subtargets of deploy setep for create signed android apk file.
# - name - this is prefix of added subtarget (any word) # - name - This is prefix of added subtarget (any word).
# - input - path to input android json file : *-deployment-settings.json # - input - Path to input android json file : *-deployment-settings.json
# - aliase - aliase for key store # - aliase - Aliase for key store.
# - keystore - path of key store # - keystore - Path of key store.
# - keystorePass - pass of keystore file # - keystorePass - Pass of keystore file.
# - targetDir - target dir for output apk file # - targetDir - Target dir for output apk file.
# #
# initDeploy() // create a main deploy target fpr all addDeploy subtargets. this method need to call befor invoced 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() // create the general release target for all subtargets addRelease. This method need to call befor invoce all addRelease methods. # initRelease() // Create the general release target for all subtargets addRelease. This method need to call before invoice all addRelease methods.
# #
# addReleaseSnap(name) // create subtargets for publish snap deployed snap package # addReleaseSnap(name) // Create subtargets for publish snap deployed snap package.
# - name - this is prefix of added subtarget (any word) # - name - This is prefix of added subtarget (any word).
# #
# addReleaseQif(name sourceDir targetDir) // create subtargets for publish the qif package on qif repository # addReleaseQif(name sourceDir targetDir) // Create subtargets for publish the qif package on qif repository.
# - name - this is prefix of added subtarget (any word) # - name - This is prefix of added subtarget (any word).
# - sourceDir - path to folder with qif template # - sourceDir - Path to folder with qif template.
# - targetDir - path to target derictory # - targetDir - Path to target directory.
# #
# #
# *** Dcumentation *** # *** Dcumentation ***
# initDoc() // create the general doc target for all subtargets addDoc. This method need to call befor invoce 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.
# - name - this is prefix of added subtarget (any word) # - name - This is prefix of added subtarget (any word).
# - doxygenFile - this is path to doxygen configuration file # - doxygenFile - This is path to doxygen configuration file.
# #
@ -331,7 +331,7 @@ function(addDeploySnap name targetDir)
find_program(SNAPCRAFT_EXE "snapcraft") find_program(SNAPCRAFT_EXE "snapcraft")
if(NOT EXISTS ${SNAPCRAFT_EXE}) if(NOT EXISTS ${SNAPCRAFT_EXE})
message("please install the snapcraft befor deploy this project! Use: sudo snap install snapcraft --classic") message("please install the snapcraft before deploy this project! Use: sudo snap install snapcraft --classic")
return() return()
endif(NOT EXISTS ${SNAPCRAFT_EXE}) endif(NOT EXISTS ${SNAPCRAFT_EXE})