Skip to content

Commit

Permalink
Doc: Normalize page names
Browse files Browse the repository at this point in the history 
qdoc does enforce lowercase file names for .html pages, and also
replaces underscore with a dash. Make sure that the original \page name
already is normalized, so that it's easier to search.

This was done by
  find . -name "*.qdoc" -exec perl -p -i -E "s/\\\page (.*)/\\\page \L\1/ && s/_/-/g" {} ;

Pick-to: 6.4
Change-Id: Ib50b85af8ffd985edf06856266eefdebf8b328a3
Reviewed-by: Paul Wicking <[email protected]>
Reviewed-by: Luca Di Sera <[email protected]>
Reviewed-by: Topi Reiniö <[email protected]>
  • Loading branch information
@kkoehne
kkoehne committed Nov 2, 2022
1 parent 265b136 commit 3834fee
Show file tree
Hide file tree
Showing 29 changed files with 73 additions and 73 deletions.
34 changes: 17 additions & 17 deletions src/corelib/doc/src/cmake/cmake-configure-variables.qdoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ find_package(Qt6 REQUIRED COMPONENTS Core)
*/

*/*!
\page cmake-variable-ANDROID_NDK_HOST_SYSTEM_NAME.html
\page cmake-variable-android-ndk-host-system-name.html
\ingroup cmake-variables-qtcore

\title ANDROID_NDK_HOST_SYSTEM_NAME
Expand All @@ -41,7 +41,7 @@ part of the deployment settings for a target.
*/

/*!
\page cmake-variable-ANDROID_SDK_ROOT.html
\page cmake-variable-android-sdk-root.html
\ingroup cmake-variables-qtcore

\title ANDROID_SDK_ROOT
Expand All @@ -60,7 +60,7 @@ It is written out as part of the deployment settings for a target.
*/

/*!
\page cmake-variable-QT_ANDROID_APPLICATION_ARGUMENTS.html
\page cmake-variable-qt-android-application-arguments.html
\ingroup cmake-variables-qtcore

\title QT_ANDROID_APPLICATION_ARGUMENTS
Expand All @@ -79,7 +79,7 @@ out as part of the deployment settings for a target.
*/

/*!
\page cmake-variable-QT_ANDROID_BUILD_ALL_ABIS.html
\page cmake-variable-qt-android-build-all-abis.html
\ingroup cmake-variables-qtcore

\title QT_ANDROID_BUILD_ALL_ABIS
Expand Down Expand Up @@ -112,7 +112,7 @@ The variable is set to FALSE by default.
*/

/*!
\page cmake-variable-QT_ANDROID_ABIS.html
\page cmake-variable-qt-android-abis.html
\ingroup cmake-variables-qtcore

\title QT_ANDROID_ABIS
Expand All @@ -137,7 +137,7 @@ QT_ANDROID_ABIS logic.
*/

/*!
\page cmake-variable-QT_PATH_ANDROID_ABI.html
\page cmake-variable-qt-path-android-abi.html
\ingroup cmake-variables-qtcore

\title QT_PATH_ANDROID_ABI_<ABI>
Expand All @@ -156,7 +156,7 @@ Each variable can be used to specify the path to Qt for Android for the correspo
*/

/*!
\page cmake-variable-QT_ANDROID_SIGN_AAB.html
\page cmake-variable-qt-android-sign-aab.html
\ingroup cmake-variables-qtcore

\title QT_ANDROID_SIGN_AAB
Expand All @@ -181,7 +181,7 @@ Mentioned variables are used internally by \l{androiddeployqt}.
*/

/*!
\page cmake-variable-QT_ANDROID_SIGN_APK.html
\page cmake-variable-qt-android-sign-apk.html
\ingroup cmake-variables-qtcore

\title QT_ANDROID_SIGN_APK
Expand All @@ -206,7 +206,7 @@ Mentioned variables are used internally by \l{androiddeployqt}.
*/

/*!
\page cmake-variable-QT_NO_COLLECT_BUILD_TREE_APK_DEPS.html
\page cmake-variable-qt-no-collect-build-tree-apk-deps.html
\ingroup cmake-variables-qtcore

\title QT_NO_COLLECT_BUILD_TREE_APK_DEPS
Expand All @@ -229,7 +229,7 @@ Set \c QT_NO_COLLECT_BUILD_TREE_APK_DEPS to \c TRUE to disable this behavior.
*/

/*!
\page cmake-variable-QT_NO_COLLECT_IMPORTED_TARGET_APK_DEPS.html
\page cmake-variable-qt-no-collect-imported-target-apk-deps.html
\ingroup cmake-variables-qtcore

\title QT_NO_COLLECT_IMPORTED_TARGET_APK_DEPS
Expand All @@ -255,7 +255,7 @@ Set \c QT_NO_COLLECT_IMPORTED_TARGET_APK_DEPS to \c TRUE to disable this behavio
*/

/*!
\page cmake-variable-QT_HOST_PATH.html
\page cmake-variable-qt-host-path.html
\ingroup cmake-variables-qtcore

\title QT_HOST_PATH
Expand All @@ -271,7 +271,7 @@ platform. It is used to locate tools to be run on the host (\l{moc}, \l{rcc},
*/

/*!
\page cmake-variable-QT_NO_SET_XCODE_DEVELOPMENT_TEAM_ID.html
\page cmake-variable-qt-no-set-xcode-development-team-id.html
\ingroup cmake-variables-qtcore

\title QT_NO_SET_XCODE_DEVELOPMENT_TEAM_ID
Expand All @@ -288,7 +288,7 @@ Set \c QT_NO_SET_XCODE_DEVELOPMENT_TEAM_ID to true if you want to prevent this.
*/

/*!
\page cmake-variable-QT_NO_SET_XCODE_BUNDLE_IDENTIFIER.html
\page cmake-variable-qt-no-set-xcode-bundle-identifier.html
\ingroup cmake-variables-qtcore

\title QT_NO_SET_XCODE_BUNDLE_IDENTIFIER
Expand All @@ -306,7 +306,7 @@ Set \c QT_NO_SET_XCODE_BUNDLE_IDENTIFIER to true if you want to prevent this.
*/

/*!
\page cmake-variable-QT_ENABLE_VERBOSE_DEPLOYMENT.html
\page cmake-variable-qt-enable-verbose-deployment.html
\ingroup cmake-variables-qtcore

\title QT_ENABLE_VERBOSE_DEPLOYMENT
Expand All @@ -326,7 +326,7 @@ must be set before the first \c{find_package(Qt6)} call to have that effect.
*/

/*!
\page cmake-variable-QT_DEPLOY_SUPPORT.html
\page cmake-variable-qt-deploy-support.html
\ingroup cmake-variables-qtcore

\title QT_DEPLOY_SUPPORT
Expand All @@ -353,7 +353,7 @@ an application, along with its runtime dependencies:
*/

/*!
\page cmake-variable-QT_NO_STANDARD_PROJECT_SETUP.html
\page cmake-variable-qt-no-standard-project-setup.html
\ingroup cmake-variables-qtcore

\title QT_NO_STANDARD_PROJECT_SETUP
Expand All @@ -376,7 +376,7 @@ methods provided by CMake.
*/

/*!
\page cmake-variable-QT_IOS_LAUNCH_SCREEN.html
\page cmake-variable-qt-ios-launch-screen.html
\ingroup cmake-variables-qtcore

\title QT_IOS_LAUNCH_SCREEN
Expand Down
14 changes: 7 additions & 7 deletions src/corelib/doc/src/cmake/cmake-deploy-variables.qdoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
**/

/*!
\page cmake-variable-QT_DEPLOY_PREFIX.html
\page cmake-variable-qt-deploy-prefix.html
\ingroup cmake-variables-qtcore

\title QT_DEPLOY_PREFIX
Expand Down Expand Up @@ -53,7 +53,7 @@ variables.
*/

/*!
\page cmake-variable-QT_DEPLOY_BIN_DIR.html
\page cmake-variable-qt-deploy-bin-dir.html
\ingroup cmake-variables-qtcore

\title QT_DEPLOY_BIN_DIR
Expand Down Expand Up @@ -94,7 +94,7 @@ should not be used for that scenario.
*/

/*!
\page cmake-variable-QT_DEPLOY_LIB_DIR.html
\page cmake-variable-qt-deploy-lib-dir.html
\ingroup cmake-variables-qtcore

\title QT_DEPLOY_LIB_DIR
Expand Down Expand Up @@ -136,7 +136,7 @@ should not be used for that scenario.
*/

/*!
\page cmake-variable-QT_DEPLOY_PLUGINS_DIR.html
\page cmake-variable-qt-deploy-plugins-dir.html
\ingroup cmake-variables-qtcore

\title QT_DEPLOY_PLUGINS_DIR
Expand Down Expand Up @@ -172,7 +172,7 @@ bundle contents.
*/

/*!
\page cmake-variable-QT_DEPLOY_QML_DIR.html
\page cmake-variable-qt-deploy-qml-dir.html
\ingroup cmake-variables-qtcore

\title QT_DEPLOY_QML_DIR
Expand Down Expand Up @@ -210,7 +210,7 @@ to be deployed to different locations within the app bundle.
*/

/*!
\page cmake-variable-QT_DEPLOY_TRANSLATIONS_DIR.html
\page cmake-variable-qt-deploy-translations-dir.html
\ingroup cmake-variables-qtcore

\title QT_DEPLOY_TRANSLATIONS_DIR
Expand Down Expand Up @@ -243,7 +243,7 @@ This variable is not meaningful when deploying on macOS or Windows.
*/

/*!
\page cmake-variable-QT_DEPLOY_IGNORED_LIB_DIRS.html
\page cmake-variable-qt-deploy-ignored-lib-dirs.html
\ingroup cmake-variables-qtcore

\title QT_DEPLOY_IGNORED_LIB_DIRS
Expand Down
Loading

0 comments on commit 3834fee

Please sign in to comment.