summaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-10-28 14:04:44 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-29 14:57:19 +0100
commitc2a6dc50a6057623f6e5e938f8bf0032ecae1eff (patch)
treec555103deff2fd95792e5a2a77892c6b6273816c /doc/src
parent3ac7bf6730e228a5c4e75beeefaade60f17cde22 (diff)
downloadqtdoc-c2a6dc50a6057623f6e5e938f8bf0032ecae1eff.tar.gz
Doc: Fixed broken links and other style issues.
-primarily fixed broken links, but fixed surrounding content. Task-number: QTBUG-33360 Change-Id: Ic38e8e13d84beb0c0ed883041387216eacd1291f Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/addons.qdoc27
-rw-r--r--doc/src/configure.qdoc4
-rw-r--r--doc/src/deployment/deployment.qdoc25
-rw-r--r--doc/src/development/cmake-manual.qdoc7
-rw-r--r--doc/src/development/debug.qdoc2
-rw-r--r--doc/src/examples/qtdemo.qdoc3
-rw-r--r--doc/src/external-resources.qdoc2
-rw-r--r--doc/src/getting-started/installation.qdoc2
-rw-r--r--doc/src/graphics.qdoc3
-rw-r--r--doc/src/mobile.qdoc4
-rw-r--r--doc/src/modules.qdoc2
-rw-r--r--doc/src/platforms/emb-fonts.qdoc2
-rw-r--r--doc/src/platforms/linux.qdoc7
-rw-r--r--doc/src/platforms/macosx.qdoc12
-rw-r--r--doc/src/platforms/wince-introduction.qdoc8
-rw-r--r--doc/src/platforms/windows.qdoc1
-rw-r--r--doc/src/qtmodules.qdoc2
17 files changed, 56 insertions, 57 deletions
diff --git a/doc/src/addons.qdoc b/doc/src/addons.qdoc
index 4a108de5..c3aa5df0 100644
--- a/doc/src/addons.qdoc
+++ b/doc/src/addons.qdoc
@@ -50,9 +50,15 @@ The \l {Qt Concurrent} module provides APIs to make it simpler and safer to
write multi-threaded code in a structured manner, enabling your
application to better exploit the hardware resources of the platform where it is running.
+\list
+\li \l{Threading Basics}
+\li \l{Thread Support in Qt}
+\endlist
+
+\target Qt Declarative
\section1 Qt Declarative Module
-The \l {Qt Declarative} module provides APIs and tools to support code written in Qt Quick 1.
+The Qt Declarative module provides APIs and tools to support code written in Qt Quick 1. For more information, visit the \l{Qt Quick 1} page.
\section1 Qt Graphical Effects Module
@@ -68,8 +74,7 @@ image formats to Qt applications.
\section1 Qt OpenGL Module
The \l{Qt OpenGL} module is primarily provided for compatibility with Qt 4. The essential
-\l{Qt GUI} module provides a set of OpenGL classes which cover most use cases where you want to
-mix Qt- and OpenGL-based code.
+\l{Qt GUI} module provides a set of OpenGL classes which cover most use cases where you want to mix Qt and OpenGL-based code.
\section1 Qt Print Support Module
@@ -79,13 +84,13 @@ paint on screen or on a \l {QImage}.
\section1 Qt Script Module
-The \l {Qt Script} module provides APIs to
-\l{Making Applications Scriptable}{make Qt applications scriptable}. This
-module is primarily provided for compatibility with Qt 4, and to support applications that
-use the \l {Qt Declarative} module. An alternative API is provided by the essential
-\l {Qt QML} module. For more information, see
-\l{Scripting Classes and Overviews}{the list of Qt Script APIs}, or
-\l{Creating Qt Script Extensions}{learn how to make your own extensions} to \l{Qt Script}.
+The \l {Qt Script} module provides APIs to \l{Making Applications
+Scriptable}{make Qt applications scriptable}. This module is primarily provided
+for compatibility with Qt 4, and to support applications that use the \l{Qt
+Declarative} module. An alternative API is provided by QJSEngine from the
+essential \l {Qt QML} module.
+
+For more information, see \l{Scripting Classes and Overviews}.
\section1 Qt SVG Module
@@ -105,6 +110,6 @@ documentation in applications, similar to Qt Assistant.
The \l {Qt XML} Module is provided for compatibility with older code. It has been superseded by
the QXmlStreamReader and QXmlStreamWriter classes in the \l {Qt Core} module.
-For more information, read the section "XML Support in Qt" in the \l {Data Structure and Storage}
+For more information, read the section "XML Support in Qt" in the \l {Data Storage}
overview.
*/
diff --git a/doc/src/configure.qdoc b/doc/src/configure.qdoc
index 1be87167..41b6f64e 100644
--- a/doc/src/configure.qdoc
+++ b/doc/src/configure.qdoc
@@ -73,7 +73,7 @@
\code
cd ~/Qt-static
- ~/qt/configure -prefix $PWD/qtbase -static
+ ~/qt/configure -prefix $PWD/qtbase -static
cd ~/Qt-dynamic
~/qt/configure -prefix $PWD/qtbase -shared
@@ -87,7 +87,7 @@
\section1 Including and Excluding Qt Modules
With configure, it is possible to include or exclude particular
- \l{All Qt Modules}{Qt modules} in a Qt build. However, keep in mind that
+ \l{All Modules}{Qt modules} in a Qt build. However, keep in mind that
many modules depend on other modules, therefore, dependency issues
can arise with some build configurations.
diff --git a/doc/src/deployment/deployment.qdoc b/doc/src/deployment/deployment.qdoc
index 07501d93..224c70b1 100644
--- a/doc/src/deployment/deployment.qdoc
+++ b/doc/src/deployment/deployment.qdoc
@@ -126,9 +126,9 @@
Depending on configuration, compiler-specific libraries must be
redistributed as well. For more information, see the
platform-specific application dependencies for
- \l{deployment-x11.html#application-dependencies}{X11},
- \l{deployment-windows.html#application-dependencies}{Windows},
- and \l{deployment-mac.html#application-dependencies}{Mac}.
+ \l{Qt for Linux/X11 - Deployment#Application Dependencies}{X11},
+ \l{Qt for Windows - Deployment#Application Dependencies}{Windows},
+ and \l{Qt for Mac OS X}{Mac OS X}.
\section1 Licensing
@@ -144,12 +144,11 @@
\table
\header \li Qt Library \li Dependency
\li Licensing Issue
- \row \li \l{QtHelp} \li CLucene
+ \row \li \l{QtHelp} \li CLucene
\li The version of clucene distributed with Qt is licensed
under the GNU LGPL version 2.1 or later. This has implications for
- developers of closed source applications. Please see
- \l{Qt Help Module#License Information}{the Qt Help module documentation}
- for more information.
+ developers of closed source applications. Please see the
+ \l{Qt Help#License Information}{Qt Help} documentation for more information.
\row \li \l{QtNetwork} \li OpenSSL
\li Some configurations of QtNetwork use OpenSSL at run-time. Deployment
@@ -160,8 +159,8 @@
\row \li \l{QtWebKit} \li WebKit
\li WebKit is licensed under the GNU LGPL version 2 or later.
This has implications for developers of closed source applications.
- Please see \l{WebKit in Qt#License Information}{the Qt WebKit module
- documentation} for more information.
+ Please see the \l{Qt WebKit Widgets#License Information}{Qt WebKit Widgets}
+ documentation for more information.
\endtable
@@ -171,13 +170,13 @@
various platforms:
\list
- \li \l{Deploying an Application on X11 Platforms}{Qt for X11 Platforms}
- \li \l{Deploying an Application on Windows}{Qt for Windows}
- \li \l{Deploying an Application on Mac OS X}{Qt for Mac OS X}
+ \li \l{Qt for Linux/X11 - Deployment}{Qt for X11 Platforms}
+ \li \l{Qt for Windows - Deployment}{Qt for Windows}
+ \li \l{Qt for Mac OS X#Deploying Applications on Mac OS X}{Qt for Mac OS X}
\li \l{Deploying an Application on Android}{Qt for Android}
\endlist
- \sa {Deploying Translations}, Installation
+ \sa {Deploying Translations}
*/
/*!
diff --git a/doc/src/development/cmake-manual.qdoc b/doc/src/development/cmake-manual.qdoc
index f71615ff..ebbb0914 100644
--- a/doc/src/development/cmake-manual.qdoc
+++ b/doc/src/development/cmake-manual.qdoc
@@ -91,9 +91,10 @@
\snippet snippets/cmake/CMakeLists.pro 2
- Plugins are also available as \c IMPORTED targets in CMake. The \l{Qt Network}, \l{Qt SQL}, \l{Qt GUI}
- and \l{Qt Widgets} modules have plugins associated. They provide a list of plugins in the
- \l{Qt5}\e{<Module>}\c{_PLUGINS} variable.
+ Plugins are also available as \c IMPORTED targets in CMake. The \l{Qt
+ Network}, \l{Qt SQL}, \l{Qt GUI}, and \l{Qt Widgets} modules have plugins
+ associated. They provide a list of plugins in the
+ \c{Qt5}\e{<Module>}\c{_PLUGINS} variable.
\snippet snippets/cmake/CMakeLists.pro 7
diff --git a/doc/src/development/debug.qdoc b/doc/src/development/debug.qdoc
index a94af25b..4f78b621 100644
--- a/doc/src/development/debug.qdoc
+++ b/doc/src/development/debug.qdoc
@@ -36,7 +36,7 @@
\section1 Configuring Qt for Debugging
- When \l{Installation}{configuring Qt for installation}, it is possible
+ When \l{Qt Configure Options}{configuring} Qt for installation, it is possible
to ensure that it is built to include debug symbols that can make it
easier to track bugs in applications and libraries. However, on some
platforms, building Qt in debug mode will cause applications to be larger
diff --git a/doc/src/examples/qtdemo.qdoc b/doc/src/examples/qtdemo.qdoc
index 7da3f6ce..3bf35f54 100644
--- a/doc/src/examples/qtdemo.qdoc
+++ b/doc/src/examples/qtdemo.qdoc
@@ -37,9 +37,6 @@
\image qtdemo.png
- The \c qtdemo executable should be installed alongside the
- \l{Qt's Tools}{other tools} supplied with Qt.
-
\list
\li On Windows, click the Start button, open the \e Programs submenu, open
the \e{Qt 4} submenu, and click \e{Examples and Demos}.
diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc
index d28fa35c..03c6eca7 100644
--- a/doc/src/external-resources.qdoc
+++ b/doc/src/external-resources.qdoc
@@ -66,5 +66,5 @@
/*!
\externalpage http://qt-project.org/wiki/Category:Add-ons
- \title Add-ons
+ \title Qt Add-ons
*/
diff --git a/doc/src/getting-started/installation.qdoc b/doc/src/getting-started/installation.qdoc
index d7616768..17667c54 100644
--- a/doc/src/getting-started/installation.qdoc
+++ b/doc/src/getting-started/installation.qdoc
@@ -97,7 +97,6 @@ More information about enabling SSL support can be found in the
\title Installing Qt for Windows CE
\ingroup qtce
\brief How to install Qt for Windows CE.
-\previouspage Installation
\tableofcontents
Qt for Windows CE has some requirements that are given in more detail
@@ -149,7 +148,6 @@ in the \l{Qt for Windows CE Requirements} document.
The links below provide further information for using Qt:
\list
- \li \l{How to Learn Qt}
\li \l{Qt Examples and Tutorials}
\li \l{Deploying Qt Applications}
\endlist
diff --git a/doc/src/graphics.qdoc b/doc/src/graphics.qdoc
index 8e738907..bae96475 100644
--- a/doc/src/graphics.qdoc
+++ b/doc/src/graphics.qdoc
@@ -91,8 +91,7 @@ The most important rendering targets for QPainter are:
\endlist
-QPainter and related classes are part of the \l {Qt GUI C++ API}{Qt GUI module},
-which is described in further detail on the \l {Qt GUI} page.
+QPainter and related classes are part of the \l {Qt GUI} module.
diff --git a/doc/src/mobile.qdoc b/doc/src/mobile.qdoc
index 155899a6..04ba3646 100644
--- a/doc/src/mobile.qdoc
+++ b/doc/src/mobile.qdoc
@@ -57,8 +57,8 @@
\section1 Positioning
Accessing location information through Global Positioning System (GPS) or
- Cell ID positioning is available through the positioning APIs from the \l{Qt
- Location} module. Additionally, devices which use NMEA protocols can be
+ Cell ID positioning is available through the positioning APIs from the Qt
+ Positioning module. Additionally, devices which use NMEA protocols can be
used as a source.
\list
diff --git a/doc/src/modules.qdoc b/doc/src/modules.qdoc
index 5f3f821d..c4132c3b 100644
--- a/doc/src/modules.qdoc
+++ b/doc/src/modules.qdoc
@@ -49,7 +49,7 @@
The QAxContainer module is not covered by the \l{GNU General Public License (GPL)},
the \l{GNU Lesser General Public License (LGPL)}, or the
- \l{Qt Commercial Edition}{Qt Commercial License}. Instead, it is distributed under
+ \l{Qt Commercial License}. Instead, it is distributed under
the following license.
\legalese
diff --git a/doc/src/platforms/emb-fonts.qdoc b/doc/src/platforms/emb-fonts.qdoc
index b36e817e..6dd7a266 100644
--- a/doc/src/platforms/emb-fonts.qdoc
+++ b/doc/src/platforms/emb-fonts.qdoc
@@ -43,7 +43,7 @@
the locally installed version of the FreeType library. When using QBasicFontDatabase,
Qt also supports the Qt Prerendered Font format (\l QPF2),
a light-weight non-scalable font formats.
- QPF2 is the native format of \l{Qt for Embedded Linux} 4.x.
+ QPF2 is the native format of Qt for Embedded Linux 4.x.
\image qt-embedded-fontfeatures.png
diff --git a/doc/src/platforms/linux.qdoc b/doc/src/platforms/linux.qdoc
index 6b43afc5..f8e72926 100644
--- a/doc/src/platforms/linux.qdoc
+++ b/doc/src/platforms/linux.qdoc
@@ -302,7 +302,7 @@
\section1 Multimedia Dependencies
- As described in the \l{Multimedia Overview}, Qt Multimedia uses the GStreamer multimedia
+ As described in the \l Multimedia overview, Qt Multimedia uses the GStreamer multimedia
framework as the backend for audio and video playback on Linux. The minimum required
version of GStreamer is 0.10.
@@ -311,7 +311,7 @@
distributions; try searching for \c gstreamer or \c libgstreamer in your
distribution's package repository to find suitable packages.
- \section1 WebKit Dependencies
+ \section1 Qt WebKit Dependencies
\l{Qt WebKit} depends on some extra development tools in addition to those required for the rest of Qt.
@@ -522,8 +522,7 @@
We assume that you already have installed Qt as a shared library,
which is the default when installing Qt, in the \c /path/to/Qt
- directory. For more information on how to build Qt, see the \l
- {Installation} documentation.
+ directory.
\section2 Linking the Application to Qt as a Shared Library
diff --git a/doc/src/platforms/macosx.qdoc b/doc/src/platforms/macosx.qdoc
index 74f6c65c..10937c17 100644
--- a/doc/src/platforms/macosx.qdoc
+++ b/doc/src/platforms/macosx.qdoc
@@ -135,14 +135,15 @@
A common way to distribute applications is to provide a compressed disk
image (.dmg file) that the user can mount in Finder. The deployment tool, \c
macdeployqt (available from the Mac OS X installers), can be used to create
- the self-contained bundles, and optionally also create a .dmg archive. See
- the \l{Deploying an Application on Mac OS X}{Mac deployment guide} for more
- information about deployment.
-
+ the self-contained bundles, and optionally also create a .dmg archive.
Applications can also be distributed through the Mac App store. Qt 5 aims
to stay within the app store sandbox rules. macdeployqt (bin/macdeployqt)
can be used as a starting point for app store deployment.
+ \list
+ \li {Qt for Mac OS X - Deployment}
+ \endlist
+
\section1 Mac OS X Issues
The page below covers specific issues and recommendations for creating
@@ -172,7 +173,6 @@
\page macosx-requirements.html
\title Qt for Mac OS X - Requirements
\brief Setting up the Mac OS X environment for Qt.
- \previouspage General Qt Requirements
Qt requires Xcode to be installed on the system. You can get it from:
@@ -428,7 +428,7 @@
deployment of applications.
Qt provides a deploy tool, \l{The Mac Deployment Tool}{macdeployqt}, to
- simplify the deployment process. The \l{Deploying an Application on Mac OS X}
+ simplify the deployment process. The \l{Qt for Mac OS X - Deployment}
article covers the deployment process in more detail.
\section2 Qt Libraries as Frameworks
diff --git a/doc/src/platforms/wince-introduction.qdoc b/doc/src/platforms/wince-introduction.qdoc
index 31d45180..9b48c861 100644
--- a/doc/src/platforms/wince-introduction.qdoc
+++ b/doc/src/platforms/wince-introduction.qdoc
@@ -82,10 +82,10 @@
\section1 Building your own applications
- If you are new to Qt development, have a look at \l{How to Learn Qt}
- and \l{Tutorials}. In general there is little or no difference in
- developing Qt applications for Windows CE compared to any of the
- other platforms supported by Qt.
+ If you are new to Qt development, have a look at \l{Qt Overviews}
+ and \l{Qt Examples And Tutorials}{Tutorials}. In general there is
+ little or no difference in developing Qt applications for Windows
+ CE compared to any of the other platforms supported by Qt.
Once you have a \c .pro file, you can build from the command line. Simply write:
diff --git a/doc/src/platforms/windows.qdoc b/doc/src/platforms/windows.qdoc
index 9c46b232..b4920b8e 100644
--- a/doc/src/platforms/windows.qdoc
+++ b/doc/src/platforms/windows.qdoc
@@ -724,6 +724,7 @@
\li \c{C:/customPath/plugins}
\li \c{C:/Qt/%VERSION%/plugins}
\li \c{E:/myApplication/directory}
+ \endlist
The executable will look for the plugins in these directories and
the same order as the QStringList returned by qApp->libraryPaths().
diff --git a/doc/src/qtmodules.qdoc b/doc/src/qtmodules.qdoc
index 5d38024f..499bb0d7 100644
--- a/doc/src/qtmodules.qdoc
+++ b/doc/src/qtmodules.qdoc
@@ -140,7 +140,7 @@
\row
\li \l{Qt Bluetooth}
\li All
- \li \l{Qt for Linux}, \l{BlackBerry}
+ \li \l{Qt for Linux/X11}, \l{BlackBerry}
\li Provides access to Bluetooth hardware.
\row
\li \l{Qt Concurrent}