From a06cdb60a8ed31c9e3994c8b9a26a4f5340c51f7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tor=20Arne=20Vestb=C3=B8?= <tor.arne.vestbo@qt.io>
Date: Thu, 4 Oct 2018 18:11:56 +0200
Subject: [PATCH] Unify naming and titles of platform support pages
- The main platform support page for a platform is just foo.html
- Sub pages are prefixed, e.g. foo-bar.html
- All titles are Qt for Foo.
- The unused file platform-notes.qdocinc was removed
Change-Id: Ie00b4c1dde1d3e80efbe6cfa5c191b3501ebde2b
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
---
doc/src/getting-started/gettingstarted.qdoc | 2 +-
...es-android.qdoc => android-platform-notes.qdoc} | 2 +-
doc/src/platforms/android.qdoc | 14 +++++++-------
.../integrity-build-monolith-app-tutorial.qdoc | 2 +-
...latform-notes-integrity.qdoc => integrity.qdoc} | 2 +-
doc/src/platforms/ios.qdoc | 6 +++---
doc/src/platforms/platform-notes.qdocinc | 0
.../{platform-notes-rtos.qdoc => qnx.qdoc} | 5 +++--
doc/src/platforms/windows.qdoc | 2 +-
9 files changed, 18 insertions(+), 17 deletions(-)
rename doc/src/platforms/{platform-notes-android.qdoc => android-platform-notes.qdoc} (99%)
rename doc/src/platforms/{platform-notes-integrity.qdoc => integrity.qdoc} (98%)
delete mode 100644 doc/src/platforms/platform-notes.qdocinc
rename doc/src/platforms/{platform-notes-rtos.qdoc => qnx.qdoc} (99%)
diff --git a/doc/src/getting-started/gettingstarted.qdoc b/doc/src/getting-started/gettingstarted.qdoc
index 8211492f..3ac171b4 100644
--- a/doc/src/getting-started/gettingstarted.qdoc
+++ b/doc/src/getting-started/gettingstarted.qdoc
@@ -86,7 +86,7 @@
Developing applications on different platforms are covered in the platform
pages.
\list
- \li \l{Getting Started with Qt for Android}{Android}
+ \li \l{Qt for Android}{Android}
\li \l{Qt for iOS}{iOS}
\li \l{Qt for Windows}{Windows}
\li \l{Qt for Linux/X11}{Linux/X11}
diff --git a/doc/src/platforms/platform-notes-android.qdoc b/doc/src/platforms/android-platform-notes.qdoc
similarity index 99%
rename from doc/src/platforms/platform-notes-android.qdoc
rename to doc/src/platforms/android-platform-notes.qdoc
index be1ee75c..6baed10f 100644
--- a/doc/src/platforms/platform-notes-android.qdoc
+++ b/doc/src/platforms/android-platform-notes.qdoc
@@ -27,7 +27,7 @@
/*!
- \page platform-notes-android.html
+ \page android-platform-notes.html
\title Platform and Compiler Notes - Android
\contentspage Platform and Compiler Notes
diff --git a/doc/src/platforms/android.qdoc b/doc/src/platforms/android.qdoc
index cd2c6e86..8261e7d0 100644
--- a/doc/src/platforms/android.qdoc
+++ b/doc/src/platforms/android.qdoc
@@ -26,7 +26,7 @@
****************************************************************************/
/*!
-\page android_support.html
+\page android.html
\title Qt for Android
\brief Provides information about Android support in Qt.
\ingroup supportedplatform
@@ -75,7 +75,7 @@ The following topics provide more details about how to use Qt for Android:
*/
/*!
- \page android3rdpartylibs.html
+ \page android-3rdparty-libs.html
\title Third-party Android Libraries
\brief Provides instructions to include third-party Android libraries in an application.
@@ -136,7 +136,7 @@ The following topics provide more details about how to use Qt for Android:
*/
/*!
-\page androidgs.html
+\page android-getting-started.html
\title Getting Started with Qt for Android
\brief Provides instructions to install and configure your development environment.
@@ -235,7 +235,7 @@ field to list all the examples tested on Android.
To develop a simple application from scratch, see \l{Creating a Mobile Application}.
*/
/*!
-\page portingtoandroid.html
+\page porting-to-android.html
\title Porting to Android
\brief Provides instructions to port your existing Qt application to Android.
@@ -296,7 +296,7 @@ AVDs found.
*/
/*!
-\page opensslsupport.html
+\page android-openssl-support.html
\title Adding OpenSSL Support for Android
\brief Provides instructions to package OpenSSL libraries with your Qt application for Android.
@@ -413,7 +413,7 @@ to deploy the APK on the target you chose and launch the application.
*/
/*!
-\page publishtogoogleplay.html
+\page android-publishing-to-googleplay.html
\title Publishing to Google Play
\brief Provides instructions to prepare your application for publishing.
@@ -482,7 +482,7 @@ packaging is done and how you can influence it.
/*!
-\page androidservices.html
+\page android-services.html
\title Android Services
\brief Provides information about Android Services support in Qt.
diff --git a/doc/src/platforms/integrity-build-monolith-app-tutorial.qdoc b/doc/src/platforms/integrity-build-monolith-app-tutorial.qdoc
index b7d5a9ec..1762c239 100644
--- a/doc/src/platforms/integrity-build-monolith-app-tutorial.qdoc
+++ b/doc/src/platforms/integrity-build-monolith-app-tutorial.qdoc
@@ -29,7 +29,7 @@
/*!
\page integrity-monolith-project-tutorial.html
\title Qt for INTEGRITY: Monolith Project Tutorial
- \previouspage platform-notes-integrity.html
+ \previouspage integrity.html
\nextpage integrity-installing-dependencies.html
The INTEGRITY applications can be monolith application projects,
diff --git a/doc/src/platforms/platform-notes-integrity.qdoc b/doc/src/platforms/integrity.qdoc
similarity index 98%
rename from doc/src/platforms/platform-notes-integrity.qdoc
rename to doc/src/platforms/integrity.qdoc
index 00c028b2..da5c127e 100644
--- a/doc/src/platforms/platform-notes-integrity.qdoc
+++ b/doc/src/platforms/integrity.qdoc
@@ -27,7 +27,7 @@
/*!
- \page platform-notes-integrity.html
+ \page integrity.html
\title Qt for INTEGRITY
\contentspage Platform Notes
\keyword INTEGRITY
diff --git a/doc/src/platforms/ios.qdoc b/doc/src/platforms/ios.qdoc
index 352187cb..d8668ab1 100644
--- a/doc/src/platforms/ios.qdoc
+++ b/doc/src/platforms/ios.qdoc
@@ -26,7 +26,7 @@
****************************************************************************/
/*!
- \page ios_support.html
+ \page ios.html
\title Qt for iOS
\brief Provides insight into Qt's iOS port and how to use it.
\ingroup supportedplatform
@@ -56,7 +56,7 @@
*/
/*!
- \page building-from-source-ios.html
+ \page ios-building-from-source.html
\title Qt for iOS - Building from Source
\brief Provides instructions to build Qt from source for iOS platform.
@@ -177,7 +177,7 @@
*/
/*!
- \page platform-notes-ios.html
+ \page ios-platform-notes.html
\title Platform Notes - iOS
\brief This page contains information about building Qt applications for and running them on the iOS platform.
diff --git a/doc/src/platforms/platform-notes.qdocinc b/doc/src/platforms/platform-notes.qdocinc
deleted file mode 100644
index e69de29b..00000000
diff --git a/doc/src/platforms/platform-notes-rtos.qdoc b/doc/src/platforms/qnx.qdoc
similarity index 99%
rename from doc/src/platforms/platform-notes-rtos.qdoc
rename to doc/src/platforms/qnx.qdoc
index b12e3238..026540f9 100644
--- a/doc/src/platforms/platform-notes-rtos.qdoc
+++ b/doc/src/platforms/qnx.qdoc
@@ -26,9 +26,10 @@
****************************************************************************/
/*!
- \page platform-notes-qnx.html
- \title Platform and Compiler Notes - QNX
+ \page qnx.html
+ \title Qt for QNX
\contentspage Platform and Compiler Notes
+ \ingroup supportedplatform
\keyword QNX
\section1 Supported Architectures and QNX Releases
diff --git a/doc/src/platforms/windows.qdoc b/doc/src/platforms/windows.qdoc
index ba32add3..6d3426cb 100644
--- a/doc/src/platforms/windows.qdoc
+++ b/doc/src/platforms/windows.qdoc
@@ -26,7 +26,7 @@
****************************************************************************/
/*!
- \page windows-support.html
+ \page windows.html
\title Qt for Windows
\brief Platform support for Windows.
\ingroup supportedplatform
--
GitLab