From e3e8118a701211404fac72e106f609cf82aaa1aa Mon Sep 17 00:00:00 2001
From: Jerome Pasion <jerome.pasion@digia.com>
Date: Mon, 6 May 2013 17:30:46 +0200
Subject: [PATCH] Doc: Various changes to the platform related documentation.
-Removed "Cross-Platform and Platform-Specific Development" page.
Our overviews are presumed to be cross-platform and the platform
specific content are in the respective platform pages. The page adds
no value to our doc architecture.
-Removed group "platform-specific" group. It is not necessary as
the platform pages already contains a link to their specific issues.
I dispersed some of the links so then they are accessible from
the platform pages.
Change-Id: I1d7eef83b8d5f1dc5af7d4c61833875da636cc39
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
---
doc/src/core.qdoc | 2 -
doc/src/deployment/deployment.qdoc | 2 +-
doc/src/development/developing-on-mac.qdoc | 6 +-
doc/src/development/developing-with-qt.qdoc | 75 ---------------------
doc/src/getting-started/known-issues.qdoc | 1 -
doc/src/howtos/unix-signal-handlers.qdoc | 3 +-
doc/src/modules.qdoc | 1 -
doc/src/overviews.qdoc | 1 -
doc/src/platforms/compiler-notes.qdoc | 1 -
doc/src/platforms/mac-differences.qdoc | 1 -
doc/src/platforms/platform-notes.qdoc | 1 -
doc/src/platforms/qtmac-as-native.qdoc | 1 -
doc/src/platforms/supported-platforms.qdoc | 17 ++---
13 files changed, 9 insertions(+), 103 deletions(-)
delete mode 100644 doc/src/development/developing-with-qt.qdoc
diff --git a/doc/src/core.qdoc b/doc/src/core.qdoc
index c972bf63..0a8c7613 100644
--- a/doc/src/core.qdoc
+++ b/doc/src/core.qdoc
@@ -80,8 +80,6 @@ Qt allows you to write platform-independent code, where the same code base can b
for and deployed on different platforms without any changes. In cases where you need to use
platform-specific features and integrate with system libraries, Qt also provides solutions
for this.
-\l{Cross-Platform and Platform-Specific Development}{Our guide to cross-platform development}
-provides information on writing software on different platforms.
Qt integrates with the windowing system on the target platform using the
\l{Qt Platform Abstraction}. This is an abstraction of the windowing system which
diff --git a/doc/src/deployment/deployment.qdoc b/doc/src/deployment/deployment.qdoc
index c0416905..e2d660c2 100644
--- a/doc/src/deployment/deployment.qdoc
+++ b/doc/src/deployment/deployment.qdoc
@@ -176,7 +176,7 @@
\li \l{Deploying an Application on Mac OS X}{Qt for Mac OS X}
\endlist
- \sa Installation, {Cross-Platform and Platform-Specific Development}
+ \sa Installation
*/
/*!
diff --git a/doc/src/development/developing-on-mac.qdoc b/doc/src/development/developing-on-mac.qdoc
index 72b412b3..c1d35301 100644
--- a/doc/src/development/developing-on-mac.qdoc
+++ b/doc/src/development/developing-on-mac.qdoc
@@ -29,7 +29,6 @@
\page developing-on-mac.html
\title Developing Qt Applications for Mac OS X
\brief Information for developing Qt applications for Mac OS X
- \ingroup platform-specific
\tableofcontents
@@ -54,11 +53,11 @@
updates to any version. We test internally against Mac OS X 10.6 and 10.7.
\section2 Carbon or Cocoa?
-
+
Qt 5 uses Cocoa. Building for Carbon is not possible.
\section2 32-bit or 64-bit
-
+
Qt can be built for either x86 or x86_64. 64-bit is used by default.
To select a 32-bit build, use the macx-clang-32 (or macx-g++32) mkspec.
This is selectable at configure time: ./configure -platform macx-clang-32
@@ -116,4 +115,3 @@
to stay within the app store sandbox rules. macdeployqt (qttools/src/macdeployqt)
can be used as a starting point for app store deployment.
*/
-
diff --git a/doc/src/development/developing-with-qt.qdoc b/doc/src/development/developing-with-qt.qdoc
deleted file mode 100644
index 1c08b90e..00000000
--- a/doc/src/development/developing-with-qt.qdoc
+++ /dev/null
@@ -1,75 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
-** Contact: http://www.qt-project.org/legal
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:FDL$
-** Commercial License Usage
-** Licensees holding valid commercial Qt licenses may use this file in
-** accordance with the commercial license agreement provided with the
-** Software or, alternatively, in accordance with the terms contained in
-** a written agreement between you and Digia. For licensing terms and
-** conditions see http://qt.digia.com/licensing. For further information
-** use the contact form at http://qt.digia.com/contact-us.
-**
-** GNU Free Documentation License Usage
-** Alternatively, this file may be used under the terms of the GNU Free
-** Documentation License version 1.3 as published by the Free Software
-** Foundation and appearing in the file included in the packaging of
-** this file. Please review the following information to ensure
-** the GNU Free Documentation License version 1.3 requirements
-** will be met: http://www.gnu.org/copyleft/fdl.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
- \page developing-with-qt.html
-
- \title Cross-Platform and Platform-Specific Development
- Qt allows you to write advanced applications and UIs once, and deploy them
- across desktop and embedded operating systems without rewriting the source
- code. The top section of this page provides an overview of the tools and
- techniques used in Qt application development. Still, you might want to add
- platform-specific features to your code. The bottom section of the page
- links to documents that describe platform-specific features provided by Qt,
- and discuss issues related to particular platforms and environments.
-
- \section1 Cross-Platform Development with Qt
-
- Qt is provided with a set of build tools to help developers automate
- the process of building and installing Qt applications.
-
- \table
- \header \li Development \li Cross-Platform Issues \li Specific Tools
- \row
- \li
- \list
- \li \l {Debugging Techniques}
- \li \l {Qt's Tools}
- \li \l {The Qt Resource System}
- \li \l {Using Precompiled Headers}
- \endlist
- \li
- \list
- \li \l {Deploying Qt Applications}
- \li \l {Installation}{Installing Qt}
- \li \l {Window System Specific Notes}
- \endlist
- \li
- \list
- \li \l {Using lupdate}{lupdate} and \l{Using lrelease}{lrelease}
- \li \l {moc}{Meta-Object Compiler (moc)}
- \li \l {User Interface Compiler (uic)}
- \li \l {Resource Compiler (rcc)}
- \endlist
- \endtable
-
- \section1 Platform-Specific Development with Qt
-
- These documents discuss platform-specific features.
-
- \annotatedlist platform-specific
-*/
diff --git a/doc/src/getting-started/known-issues.qdoc b/doc/src/getting-started/known-issues.qdoc
index 6d245773..f5aba16b 100644
--- a/doc/src/getting-started/known-issues.qdoc
+++ b/doc/src/getting-started/known-issues.qdoc
@@ -28,7 +28,6 @@
/*!
\page known-issues.html
\title Known Issues
- \ingroup platform-specific
\brief Links to online resources stating known issues in this Qt version at the time of release.
\list
diff --git a/doc/src/howtos/unix-signal-handlers.qdoc b/doc/src/howtos/unix-signal-handlers.qdoc
index 04248faf..16714d25 100644
--- a/doc/src/howtos/unix-signal-handlers.qdoc
+++ b/doc/src/howtos/unix-signal-handlers.qdoc
@@ -30,7 +30,6 @@
\title Calling Qt Functions From Unix Signal Handlers
\brief You can't. But don't despair, there is a way...
- \ingroup platform-specific
\ingroup best-practices
You \e can't call Qt functions from Unix signal handlers. The
@@ -58,7 +57,7 @@
SIGTERM signals. Note: You should read the socketpair(2) and the
sigaction(2) man pages before plowing through the following code
snippets.
-
+
\snippet doc/src/snippets/code/doc_src_unix-signal-handlers.cpp 0
In the MyDaemon constructor, use the socketpair(2) function to
diff --git a/doc/src/modules.qdoc b/doc/src/modules.qdoc
index 33a686c5..5c1b413f 100644
--- a/doc/src/modules.qdoc
+++ b/doc/src/modules.qdoc
@@ -243,7 +243,6 @@
\page qtmain.html
\title The qtmain Library
\ingroup licensing
- \ingroup platform-specific
\brief Describes the use and license of the qtmain helper library.
qtmain is a helper library that enables the developer to write a
diff --git a/doc/src/overviews.qdoc b/doc/src/overviews.qdoc
index fbbbd5bb..2203bd9a 100644
--- a/doc/src/overviews.qdoc
+++ b/doc/src/overviews.qdoc
@@ -59,7 +59,6 @@
\group qt-activex
\title ActiveX in Qt
\ingroup technology-apis
- \ingroup platform-specific
\brief Qt API's for using ActiveX controls, servers, and COM.
diff --git a/doc/src/platforms/compiler-notes.qdoc b/doc/src/platforms/compiler-notes.qdoc
index b3079fbe..0e0ce894 100644
--- a/doc/src/platforms/compiler-notes.qdoc
+++ b/doc/src/platforms/compiler-notes.qdoc
@@ -27,7 +27,6 @@
/*!
\page compiler-notes.html
- \ingroup platform-specific
\title Compiler Notes
\brief Information about the C++ compilers and tools used to build Qt.
diff --git a/doc/src/platforms/mac-differences.qdoc b/doc/src/platforms/mac-differences.qdoc
index 971ad3b9..3c45b96a 100644
--- a/doc/src/platforms/mac-differences.qdoc
+++ b/doc/src/platforms/mac-differences.qdoc
@@ -29,7 +29,6 @@
\page mac-differences.html
\title Qt for Mac OS X - Specific Issues
\brief A description of issues with Qt that are specific to Mac OS X.
- \ingroup platform-specific
This file outlines known issues and possible workarounds when
using Qt for Mac OS X. Contact Qt's technical support team if you find
diff --git a/doc/src/platforms/platform-notes.qdoc b/doc/src/platforms/platform-notes.qdoc
index acd40de4..6481f518 100644
--- a/doc/src/platforms/platform-notes.qdoc
+++ b/doc/src/platforms/platform-notes.qdoc
@@ -27,7 +27,6 @@
/*!
\page platform-notes.html
- \ingroup platform-specific
\title Platform and Compiler Notes
\brief Information about the platforms on which Qt can be used.
diff --git a/doc/src/platforms/qtmac-as-native.qdoc b/doc/src/platforms/qtmac-as-native.qdoc
index 734f90a4..aee47b70 100644
--- a/doc/src/platforms/qtmac-as-native.qdoc
+++ b/doc/src/platforms/qtmac-as-native.qdoc
@@ -29,7 +29,6 @@
\page qtmac-as-native.html
\title Qt is Mac OS X Native
\brief An explanation of Qt's native features on Mac OS X.
- \ingroup platform-specific
This document explains what makes an application native on Mac OS X.
It shows the areas where Qt is compliant, and the grey areas where
diff --git a/doc/src/platforms/supported-platforms.qdoc b/doc/src/platforms/supported-platforms.qdoc
index 04e63644..5223f37d 100644
--- a/doc/src/platforms/supported-platforms.qdoc
+++ b/doc/src/platforms/supported-platforms.qdoc
@@ -29,7 +29,6 @@
\page windows-support.html
\title Support for Windows
\brief Platform support for Windows.
- \ingroup platform-specific
\ingroup platform-details
\section1 Qt on Windows
@@ -74,7 +73,7 @@
\li \l{Network programming with Qt}{Networking}, \l{QtXml Module}
{XML} and \l{SQL in Qt}{database} functionality
\li \l{ECMAScript Reference}{ECMA standard} scripting engine
- \li \l{Qt X11 Extras} - provides APIs for X11
+ \li \l{ActiveX in Qt}
\endlist
\section2 Integrated Development Tools
@@ -107,15 +106,12 @@
the Qt Meta-Object Compiler, User Interface Compiler, and Resource
Compiler.
- Additional \l{Cross-Platform and Platform-Specific Development}
- information.
*/
/*!
\page linuxX11-support.html
\title Support for Linux/X11
\brief Platform support for Linux/X11.
- \ingroup platform-specific
\ingroup platform-details
\section1 Qt on Linux/X11
@@ -186,6 +182,7 @@
\li \l{Network programming with Qt}{Networking}, \l{QtXml Module}
{XML} and \l{SQL in Qt}{database} functionality
\li \l{ECMAScript Reference}{ECMA standard} scripting engine
+ \li \l{Qt X11 Extras} - provides APIs for X11
\endlist
\section2 Qt is the Foundation of KDE
@@ -195,16 +192,12 @@
Qt forms the foundation for thousands of open source KDE applications
developed by community members worldwide.
- Additional \l{Cross-Platform and Platform-Specific Development}
- information.
-
*/
/*!
\page mac-support.html
\title Support for Mac OS X
\brief Platform support for Mac OS X.
- \ingroup platform-specific
\ingroup platform-details
\section1 Qt on Mac OS X
@@ -219,14 +212,14 @@
\list
\li \l{Getting Started with Qt}
- \li \l{Supported Platforms}{Supported Mac OS X platforms} - Qt supports
- a wide range of Mac platform variants.
\li \l{Qt for Mac OS X Requirements}{Qt for Mac OS X Requirements}
- Software required to run Qt on Mac OS X.
\li \l{Installing Qt for Mac OS X}{Installing Qt for Mac OS X}
- Build Qt for Mac OS X development.
\li \l{Platform and Compiler Notes - Mac OS X}{Platform and Compiler Notes - Mac OS X}
- Platform specific notes.
+ \li \l{Developing Qt Applications for Mac OS X}
+ \li \l{Qt for Mac OS X - Specific Issues}{Specific Issues}
\endlist
\section1 Key Features for Mac OS X Development
@@ -273,6 +266,7 @@
\li \l{Network programming with Qt}{Networking}, \l{QtXml Module}
{XML} and \l{SQL in Qt}{database} functionality
\li \l{ECMAScript Reference}{ECMA standard} scripting engine
+ \li \l{Qt is Mac OS X Native}{Native} support
\endlist
*/
@@ -280,7 +274,6 @@
\page supported-platforms.html
\title Supported Platforms
\brief The platforms supported by Qt.
- \ingroup platform-specific
\group platform-details
Qt is a cross-platform application and UI framework. Using Qt,
--
GitLab