diff options
author | Jake Petroules <jake.petroules@petroules.com> | 2015-06-22 19:49:57 -0700 |
---|---|---|
committer | Jake Petroules <jake.petroules@petroules.com> | 2015-06-23 16:30:04 +0000 |
commit | 5533a34d0783450b4de30797f3dd001a028ff2b1 (patch) | |
tree | b0c3c76d39ba81b28c12af176e2f784951cc4bd1 /doc/reference/modules/nsis-module.qdoc | |
parent | 26c06fa5765f97c567890adef3446887ec148de8 (diff) |
Move the remaining modules to the new documentation format.
Change-Id: I7e18b023bd6292b2b320b6871752b48e5866759f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>
Diffstat (limited to 'doc/reference/modules/nsis-module.qdoc')
-rw-r--r-- | doc/reference/modules/nsis-module.qdoc | 243 |
1 files changed, 92 insertions, 151 deletions
diff --git a/doc/reference/modules/nsis-module.qdoc b/doc/reference/modules/nsis-module.qdoc index 747cd36ea..7d36c2791 100644 --- a/doc/reference/modules/nsis-module.qdoc +++ b/doc/reference/modules/nsis-module.qdoc @@ -47,158 +47,99 @@ \section1 General Properties - - \section2 defines - - \table - \row \li \b{Type:} \li \c{stringList} - \row \li \b{Default:} \li \c{undefined} - \endtable - - List of preprocessor macros that get passed to the compiler. - To set macro values, use the following syntax: - \code - cpp.defines: ["USE_COLORS=1", 'COLOR_STR="blanched almond"'] - \endcode - - \section2 disableConfig - - \table - \row \li \b{Type:} \li \c{bool} - \row \li \b{Default:} \li \c{false} - \endtable - - Whether to disable inclusion of nsisconf.nsh. Generally you do not need to set this property. - - \section2 enableQbsDefines - - \table - \row \li \b{Type:} \li \c{bool} - \row \li \b{Default:} \li \c{true} - \endtable - - Whether to define preprocessor macros corresponding to values from the project and product - objects. When building a 64-bit package, the preprocessor variable \c{Win64} will also be - defined. - - \section2 warningLevel - - \table - \row \li \b{Type:} \li \c{string} - \row \li \b{Allowed Values:} \li \c{"none"}, \c{"normal"}, \c{"errors"}, - \c{"warnings"}, \c{"info"}, \c{"all"} - \row \li \b{Default:} \li \c{"normal"} - \endtable - - Severity of warnings to emit. The higher the level, the more warnings will be shown. - The levels \c{none}, \c{errors}, \c{warnings}, \c{info} and \c{all} correspond to NSIS - verbosity levels 0 through 4, inclusive. \c{normal} corresponds to the default level. - - \section2 compilerFlags - \table - \row \li \b{Type:} \li \c{stringList} - \row \li \b{Default:} \li undefined - \endtable - - Additional flags for the NSIS compiler. - - \section2 compressor - - \table - \row \li \b{Type:} \li \c{string} - \row \li \b{Allowed Values:} \li \c{"default"}, - \c{"zlib"}, \c{"zlib-solid"}, - \c{"bzip2"}, \c{"bzip2-solid"}, - \c{"lzma"}, \c{"lzma-solid"} - \row \li \b{Default:} \li \c{"default"} + \header + \li Property + \li Type + \li Default + \li Description \row + \li defines + \li stringList + \li \c{undefined} + \li List of preprocessor macros that get passed to the compiler. + To set macro values, use the following syntax: + \c{cpp.defines: ["USE_COLORS=1", 'COLOR_STR="blanched almond"']} + \row + \li disableConfig + \li bool + \li \c{false} + \li Whether to disable inclusion of nsisconf.nsh. + Generally you do not need to set this property. + \row + \li enableQbsDefines + \li bool + \li \c{true} + \li Whether to define preprocessor macros corresponding to values from the project and + product objects. When building a 64-bit package, the preprocessor variable \c{Win64} + will also be defined. + \row + \li warningLevel + \li string + \li \c{"normal"} + \li Severity of warnings to emit. The higher the level, the more warnings will be shown. + The levels \c{none}, \c{errors}, \c{warnings}, \c{info} and \c{all} correspond to NSIS + verbosity levels 0 through 4, inclusive. \c{normal} corresponds to the default level. + \row + \li compilerFlags + \li stringList + \li undefined + \li Additional flags for the NSIS compiler. + \row + \li compressor + \li string + \li \c{"default"} + \li Compression algorithm used to compress files and data in the installer. + Setting this property overrides any SetCompressor command in the NSI file being + compiled. Possible values include: \c{"default"}, \c{"zlib"}, \c{"zlib-solid"}, + \c{"bzip2"}, \c{"bzip2-solid"}, \c{"lzma"}, \c{"lzma-solid"} + \row + \li version + \li string + \li \c{undefined} + \li The NSIS version. Consists of four numbers separated by dots, for instance "2.46.0.0". + \row + \li versionMajor + \li int + \li \c{versionParts[0]} + \li The NSIS major version. + \row + \li versionMinor + \li int + \li \c{versionParts[1]} + \li The NSIS minor version. + \row + \li versionParts + \li list + \li \c{empty} + \li The NSIS version as a list. For instance, NSIS version 2.46.0.0 would correspond to a + value of \c[2, 46, 0, 0]. + \row + \li versionPatch + \li int + \li \c{versionParts[2]} + \li The NSIS patch level. + \row + \li versionBuild + \li int + \li \c{versionParts[3]} + \li The fourth NSIS version number component. + \row + \li toolchainInstallPath + \li path + \li determined automatically + \li NSIS installation directory. Determined by searching known registry keys and known + installation paths until a match is found. This should not normally need to be changed. + \row + \li compilerName + \li string + \li \c{"makensis"} + \li Name of the compiler binary. This should not normally need to be changed. + \row + \li compilerPath + \li string + \li \c{compilerName} + \li Directory where the compiler binary is located. This should not normally need to be + changed. \endtable - - Compression algorithm used to compress files and data in the installer. - Setting this property overrides any SetCompressor command in the NSI file being compiled. - - \section2 version - - \table - \row \li \b{Type:} \li \c{string} - \row \li \b{Default:} \li \c{undefined} - \endtable - - The NSIS version. Consists of four numbers separated by dots, for instance "2.46.0.0". - - \section2 versionMajor - - \table - \row \li \b{Type:} \li \c{int} - \row \li \b{Default:} \li \c{versionParts[0]} - \endtable - - The NSIS major version. - - \section2 versionMinor - - \table - \row \li \b{Type:} \li \c{int} - \row \li \b{Default:} \li \c{versionParts[1]} - \endtable - - The NSIS minor version. - - \section2 versionParts - - \table - \row \li \b{Type:} \li \c{list} - \row \li \b{Default:} \li \c{empty} - \endtable - - The NSIS version as a list. For instance, NSIS version 2.46.0.0 would correspond to a value of - \c[2, 46, 0, 0]. - - \section2 versionPatch - - \table - \row \li \b{Type:} \li \c{int} - \row \li \b{Default:} \li \c{versionParts[2]} - \endtable - - The NSIS patch level. - - \section2 versionBuild - - \table - \row \li \b{Type:} \li \c{int} - \row \li \b{Default:} \li \c{versionParts[3]} - \endtable - - The fourth NSIS version number component. - - \section2 toolchainInstallPath - - \table - \row \li \b{Type:} \li \c{path} - \row \li \b{Default:} \li determined automatically - \endtable - - NSIS installation directory. Determined by searching known registry keys and - known installation paths until a match is found. - This should not normally need to be changed. - - \section2 compilerName - - \table - \row \li \b{Type:} \li \c{string} - \row \li \b{Default:} \li \c{"makensis"} - \endtable - - Name of the compiler binary. This should not normally need to be changed. - - \section2 compilerPath - - \table - \row \li \b{Type:} \li \c{string} - \row \li \b{Default:} \li \c{compilerName} - \endtable - - Directory where the compiler binary is located. This should not normally need to be changed. */ |