diff options
Diffstat (limited to 'qmake/doc')
-rw-r--r-- | qmake/doc/qmake.qdocconf | 13 | ||||
-rw-r--r-- | qmake/doc/src/qmake-manual.qdoc | 117 |
2 files changed, 109 insertions, 21 deletions
diff --git a/qmake/doc/qmake.qdocconf b/qmake/doc/qmake.qdocconf index 1a23237999..3493a697f4 100644 --- a/qmake/doc/qmake.qdocconf +++ b/qmake/doc/qmake.qdocconf @@ -1,6 +1,7 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) project = QMake +moduleheader = qmake_pch.h description = QMake Manual qhp.projects = qmake @@ -30,12 +31,10 @@ depends += \ qtassistant \ qtbluetooth \ qtconcurrent \ - qtcontacts \ qtcore \ qtdbus \ qtdoc \ qtdesigner \ - qtfeedback \ qtgraphicaleffects \ qtgui \ qthelp \ @@ -43,31 +42,21 @@ depends += \ qtlinguist \ qtlocation \ qtmultimedia \ - qtmultimediawidgets \ qtnetwork \ qtopengl \ - qtorganizer \ qtprintsupport \ - qtpublishsubscribe \ qtqml \ qtquick \ qtquickcontrols \ - qtquickcontrolsstyles \ qtquickdialogs \ - qtquicklayouts \ qtscript \ qtscripttools \ qtsensors \ qtserialport \ - qtserviceframework \ qtsql \ qtsvg \ - qtsysteminfo \ qttestlib \ qtuitools \ - qtversit \ - qtwebkit \ - qtwebkitexamples \ qtwidgets \ qtwinextras \ qtx11extras \ diff --git a/qmake/doc/src/qmake-manual.qdoc b/qmake/doc/src/qmake-manual.qdoc index 75a93fd996..cc3b73418b 100644 --- a/qmake/doc/src/qmake-manual.qdoc +++ b/qmake/doc/src/qmake-manual.qdoc @@ -939,6 +939,8 @@ order in which they are given. \row \li precompile_header \li Enables support for the use of \l{Using Precompiled Headers}{precompiled headers} in projects. + \row \li precompile_header_c (MSVC only) \li Enables support for the use of + \l{Using Precompiled Headers}{precompiled headers} for C files. \row \li warn_on \li The compiler should output as many warnings as possible. If \c warn_off is also specified, the last one takes effect. \row \li warn_off \li The compiler should output as few warnings as possible. @@ -1324,6 +1326,30 @@ \snippet code/doc_src_qmake-manual.pro 40 + \target OBJECTIVE_HEADERS + \section1 OBJECTIVE_HEADERS + + Defines the Objective-C++ header files for the project. + + qmake automatically detects whether \l{moc} is required by the classes in the + headers, and adds the appropriate dependencies and files to the project for + generating and linking the moc files. + + This is similar to the HEADERS variable, but will let the generated moc + files be compiled with the Objective-C++ compiler. + + See also \l{#OBJECTIVE_SOURCES}{OBJECTIVE_SOURCES}. + + \target OBJECTIVE_SOURCES + \section1 OBJECTIVE_SOURCES + + Specifies the names of all Objective-C/C++ source files in the project. + + This variable is now obsolete, Objective-C/C++ files (.m and .mm) can be + added to the \l{#SOURCES}{SOURCES} variable. + + See also \l{#OBJECTIVE_HEADERS}{OBJECTIVE_HEADERS}. + \target OBJECTS \section1 OBJECTS @@ -1797,9 +1823,55 @@ Specifies the name of the property list file, \c{.plist}, you would like to include in your \macos, iOS, tvOS, and watchOS application bundle. - In the \c{.plist} file, you can define some variables, e.g., @EXECUTABLE@, - which qmake will replace with the actual executable name. Other variables - include @ICON@, @TYPEINFO@, @LIBRARY@, and @SHORT_VERSION@. + In the \c{.plist} file, you can define some variables which + qmake will replace with the relevant values: + + \table + \header + \li Placeholder(s) + \li Effect + \row + \li \c ${PRODUCT_BUNDLE_IDENTIFIER}, \c @BUNDLEIDENTIFIER@ + \li Expands to the target bundle's bundle identifier string, + for example: \c{com.example.myapp}. Determined by concatenating the + values of QMAKE_TARGET_BUNDLE_PREFIX and QMAKE_BUNDLE, separated + by a full stop (\c{.}). + \row + \li \c ${EXECUTABLE_NAME}, \c @EXECUTABLE@, \c @LIBRARY@ + \li Equivalent to the value of QMAKE_APPLICATION_BUNDLE_NAME, + QMAKE_PLUGIN_BUNDLE_NAME, or QMAKE_FRAMEWORK_BUNDLE_NAME + (depending on the type of target being created), + or TARGET if none of the previous values are set. + \row + \li \c ${ASSETCATALOG_COMPILER_APPICON_NAME}, \c @ICON@ + \li Expands to the value of ICON. + \row + \li \c ${QMAKE_PKGINFO_TYPEINFO}, \c @TYPEINFO@ + \li Expands to the value of QMAKE_PKGINFO_TYPEINFO. + \row + \li \c ${QMAKE_FULL_VERSION}, \c @FULL_VERSION@ + \li Expands to the value of VERSION expressed with three version components. + \row + \li \c ${QMAKE_SHORT_VERSION}, \c @SHORT_VERSION@ + \li Expands to the value of VERSION expressed with two version components. + \row + \li \c ${MACOSX_DEPLOYMENT_TARGET} + \li Expands to the value of QMAKE_MACOSX_DEPLOYMENT_TARGET. + \row + \li \c ${IPHONEOS_DEPLOYMENT_TARGET} + \li Expands to the value of QMAKE_IPHONEOS_DEPLOYMENT_TARGET. + \row + \li \c ${TVOS_DEPLOYMENT_TARGET} + \li Expands to the value of QMAKE_TVOS_DEPLOYMENT_TARGET. + \row + \li \c ${WATCHOS_DEPLOYMENT_TARGET} + \li Expands to the value of QMAKE_WATCHOS_DEPLOYMENT_TARGET. + \endtable + + \note When using the Xcode generator, the above \c{${var}}-style + placeholders are replaced directly by the Xcode build system and are not + handled by qmake. The \c{@var@} style placeholders work only with the qmake + Makefile generators and not with the Xcode generator. If building for iOS, and the \c{.plist} file contains the key \c NSPhotoLibraryUsageDescription, qmake will include an additional plugin @@ -2266,6 +2338,14 @@ For more information, see \l {Expressing Supported iOS Versions}. + \section1 QMAKE_UIC_FLAGS + + This variable is used to customize the list of options passed to the + \l{uic}{User Interface Compiler} in each of the build rules where it is + used. For example, \c{-no-stringliteral} can be passed to use QLatin1String + instead of QStringLiteral in generated code (which is the default for + dynamic libraries). + \section1 QMAKE_WATCHOS_DEPLOYMENT_TARGET \note This variable is used on the watchOS platform only. @@ -3091,11 +3171,6 @@ \snippet code/doc_src_qmake-manual.pro 70 - \section2 sprintf(string, arguments...) - - Replaces %1-%9 with the arguments passed in the comma-separated list - of function \c arguments and returns the processed string. - \section2 resolve_depends(variablename, prefix) This is an internal function that you will typically not need. @@ -3162,6 +3237,11 @@ \snippet code/doc_src_qmake-manual.pro 168 + \section2 sprintf(string, arguments...) + + Replaces %1-%9 in \c string with the arguments passed in the comma-separated + list of function \c arguments and returns the processed string. + \target str_member() \section2 str_member(arg [, start [, end]]) @@ -3229,7 +3309,7 @@ \section2 system_quote(arg) - Quotes \c arg for the for the shell that is used by the \c{system()} + Quotes \c arg for the shell that is used by the \c{system()} functions. See also \l{shell_quote(arg)}{shell_quote()}. @@ -3560,6 +3640,20 @@ \snippet code/doc_src_qmake-manual.pro 169 + \section2 versionAtLeast(variablename, versionNumber) + + Tests that the version number from \c variablename is greater than or equal + to \c versionNumber. The version number is considered to be a sequence of + non-negative decimal numbers delimited by '.'; any non-numerical tail of + the string will be ignored. Comparison is performed segment-wise from left + to right; if one version is a prefix of the other, it is considered smaller. + + \section2 versionAtMost(variablename, versionNumber) + + Tests that the version number from \c variablename is less than or equal to + \c versionNumber. Works as + \l{versionAtLeast(variablename, versionNumber)}{versionAtLeast()}. + \section2 warning(string) Always succeeds, and displays \c string as a warning message to the user. @@ -4534,6 +4628,11 @@ \snippet code/doc_src_qmake-manual.pro 106 + To use the precompiled header also for C files on MSVC nmake target, add + \c precompile_header_c to the \l{CONFIG} variable. If the header is + used also for C++ and it contains C++ keywords/includes, enclose them + with \c{#ifdef __cplusplus}). + \section1 Notes on Possible Issues On some platforms, the file name suffix for precompiled header files is |