CMake: Add reference documentation for QT_IOS_LAUNCH_SCREEN

Amends 578f4ba Pick-to: 6.4 Task-number: QTBUG-104519 Change-Id: I02ea0694ead0e5b8c7a70a09cc14b51d8e374dd5 Reviewed-by: Jörg Bornemann <[email protected]>
philipp-michelfeit · Sep 2, 2022 · 3eb2918 · 3eb2918
1 parent b8a9527
commit 3eb2918
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 5 deletions.
diff --git a/doc/global/macros.qdocconf b/doc/global/macros.qdocconf
@@ -85,3 +85,6 @@ macro.cmakevariableandroidonly = "\\note This variable is used only if targeting
 macro.versionlessCMakeCommandsNote = "If \\l{Versionless commands}{versionless commands} are disabled, use \\c{\1} instead. It supports the same set of arguments as this command."
 
 macro.cmakepropertywebassemblyonly = "\\note This property is used only if targeting the WebAssembly platform."
+
+macro.cmakepropertyiosonly = "\\note This property is used only if targeting iOS."
+macro.cmakevariableiosonly = "\\note This variable is used only if targeting iOS."
diff --git a/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc b/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc
@@ -98,11 +98,11 @@ supplied by the Qt installer, with the corresponding naming of the directories.
 The typical directory structure looks as below:
 \badcode
 /path/to/Qt/6.x.x
-    android_armv7
-    android_arm64_v8a
-    android_x86
-    android_x86_64
-    ...
+    android_armv7
+    android_arm64_v8a
+    android_x86
+    android_x86_64
+    ...
 \endcode
 The auto-detected paths can be customized using one of \c{QT_PATH_ANDROID_ABI_<ABI>} variables.
 
@@ -349,3 +349,22 @@ methods provided by CMake.
 
 \sa {qt6_standard_project_setup}{qt_standard_project_setup()}
 */
+
+/*!
+\page cmake-variable-QT_IOS_LAUNCH_SCREEN.html
+\ingroup cmake-variables-qtcore
+
+\title QT_IOS_LAUNCH_SCREEN
+\target cmake-variable-QT_IOS_LAUNCH_SCREEN
+
+\summary {Path to iOS launch screen storyboard used by all targets}
+
+\cmakevariablesince 6.4
+\preliminarycmakevariable
+\cmakevariableiosonly
+
+Specifies the path to an iOS launch screen storyboard file that will be used
+by all targets within a project.
+
+\sa {Launch Screens and Launch Images}
+*/
diff --git a/src/corelib/doc/src/cmake/cmake-properties.qdoc b/src/corelib/doc/src/cmake/cmake-properties.qdoc
@@ -481,3 +481,22 @@ QT_WASM_INITIAL_MEMORY must be a multiple of 65536 bytes.
 
 For more information, see \l{https://github.com/emscripten-core/emscripten/blob/main/src/settings.js}{Emscripten compiler settings}.
 */
+
+/*!
+\page cmake-target-property-QT_IOS_LAUNCH_SCREEN.html
+\ingroup cmake-properties-qtcore
+\ingroup cmake-target-properties-qtcore
+
+\title QT_IOS_LAUNCH_SCREEN
+\target cmake-target-property-QT_IOS_LAUNCH_SCREEN
+
+\summary {Path to iOS launch screen storyboard}
+
+\cmakepropertysince 6.4
+\preliminarycmakeproperty
+\cmakepropertyiosonly
+
+Specifies the path to an iOS launch screen storyboard file.
+
+\sa {Launch Screens and Launch Images}
+*/