Commit c0704c20 authored by Leena Miettinen's avatar Leena Miettinen

Doc: use cross-linking to Qt module documentation

Replace links to "\l{http://qt-project.org/doc/"
with links to topic titles. Remove links where QDoc
creates them automatically based on the .index files.
Add the .index files for the modules that are discussed
in the Qt Creator Manual.

Note: the links will only be generated if the Qt used to
build the docs contains the linked modules and documentation
(.index file) has been generated for them.

Change-Id: Ibe624bf3773e7c854c03ebba4db406be0b4a7b90
Reviewed-by: default avatarJerome Pasion <jerome.pasion@digia.com>
Reviewed-by: default avatarEike Ziller <eike.ziller@digia.com>
parent e7778d14
......@@ -10,7 +10,20 @@ exampledirs = $SRCDIR/examples \
indexes += $QT_INSTALL_DOCS/qtwidgets/qtwidgets.index \
$QT_INSTALL_DOCS/qtcore/qtcore.index \
$QT_INSTALL_DOCS/qtqml/qtqml.index \
$QT_INSTALL_DOCS/qtquick/qtquick.index
$QT_INSTALL_DOCS/qtquick/qtquick.index \
$QT_INSTALL_DOCS/qmake/qmake.index \
$QT_INSTALL_DOCS/qtdesigner/qtdesigner.index \
$QT_INSTALL_DOCS/qtdoc/qtdoc.index \
$QT_INSTALL_DOCS/qtgui/qtgui.index \
$QT_INSTALL_DOCS/qthelp/qthelp.index \
$QT_INSTALL_DOCS/qtquickcontrols/qtquickcontrols.index \
$QT_INSTALL_DOCS/qtquicklayouts/qtquicklayouts.index \
$QT_INSTALL_DOCS/qtlinguist/qtlinguist.index \
$QT_INSTALL_DOCS/qtscript/qtscript.index \
$QT_INSTALL_DOCS/qtsensors/qtsensors.index \
$QT_INSTALL_DOCS/qtuitools/qtuitools.index \
$QT_INSTALL_DOCS/qtwebkit/qtwebkit.index \
$QT_INSTALL_DOCS/qtxml/qtxml.index
include(macros.qdocconf)
include(qt-cpp-ignore.qdocconf)
......
......@@ -142,8 +142,7 @@
SDK to get the API and tools packages needed for development. In addition,
you must install Qt for Android as part of Qt 5.2, or later.
For more information, see
\l{http://qt-project.org/doc/qt-5/android-support.html}{Qt for Android}.
For more information, see \l{Qt for Android}.
To configure connections between \QC and Android devices:
......
......@@ -155,7 +155,7 @@
import QtSensors 5.0
\endcode
\li Add the Accelerometer type with the necessary properties:
\li Add the \l{Accelerometer} type with the necessary properties:
\quotefromfile accelbubble/main.qml
\skipto Accelerometer
......
......@@ -154,8 +154,7 @@
For more information, see \l{Selecting Android Devices}.
For more information about the \c androiddeployqt tool, see
\l{http://qt-project.org/doc/qt-5/deployment-android.html}
{Deploying an Application on Android}.
\l{Deploying an Application on Android}.
\section2 Specifying Settings for Qt 5 Packages
......@@ -168,8 +167,7 @@
The anddroiddeployqt tool uses the information in the project .pro file to
create APKs. For more information about the qmake variables
that you can set in the .pro file to tailor the APK, see
\l{http://qt-project.org/doc/qt-5/deployment-android.html#qmake-variables}
{qmake Variables}.
\l{Deploying an Application on Android#qmake-variables}{qmake Variables}.
You can view information about what the anddroiddeployqt tool is doing in
the \gui {Compile Output} pane. To view additional information, select the
......
......@@ -31,7 +31,7 @@
\title Debugging a Qt Quick Example Application
This section uses the
\l{http://qt-project.org/doc/qt-5.0/qtquick/qtquick2-qml-advtutorial.html}{Same Game}
\l{QML Advanced Tutorial}{Same Game}
example application to illustrate how to debug Qt Quick applications in the
\gui Debug mode.
......
......@@ -161,11 +161,11 @@
\section1 Using Custom Styles
\QC is a \l{http://qt-project.org/doc/qt-5.0/qtwidgets/qapplication.html#QApplication}
\QC is a \l{QApplication}
{Qt application}, and therefore, it accepts the command line options
that all Qt applications accept. For example, you can use the \c {-style} and
\c {-stylesheet} options to apply custom styles and
\l{http://qt-project.org/doc/qt-5.0/qtwidgets/stylesheet.html}{stylesheets}.
\l{QApplication#stylesheet}{stylesheets}.
The styling is only applied during the current session.
Exercise caution when applying styles, as overriding the existing styling
......
......@@ -55,9 +55,7 @@
specify other command line arguments for the tools, select \gui {Tools >
External > Configure}.
For more information about Qt Linguist, see
\l{http://qt-project.org/doc/qt-5.0/qtlinguist/qtlinguist-index.html}
{Qt Linguist Manual}.
For more information about Qt Linguist, see \l{Qt Linguist Manual}.
\section1 Previewing QML Files
......
......@@ -177,9 +177,7 @@
\li Create a .qch file from your documentation.
For information on how to prepare your documentation and create a
.qch file, see
\l{http://qt-project.org/doc/qt-5.0/qthelp/qthelp-framework.html}
{The Qt Help Framework}.
.qch file, see \l{The Qt Help Framework}.
\li To add the .qch file to \QC, select \gui Tools > \gui Options >
\gui Help > \gui Documentation > \gui Add.
......
......@@ -42,8 +42,7 @@
field displays the location of the file on the development PC. The
\gui {Remote Directory} field displays the folder where the file is
installed on the device. Text in red color indicates that the information is
missing. Edit the qmake
\l{http://qt-project.org/doc/qt-5.0/qtdoc/qmake-variable-reference.html#installs}
missing. Edit the qmake \l{Variables#installs}
{INSTALLS variable} in the project .pro file to add the missing files.
When you run the application, \QC copies the necessary files to the device
......
......@@ -67,9 +67,7 @@
contained in a .qml file. For instance, a Button component may
be defined in Button.qml. The QML runtime may instantiate this
Button component to create Button objects. Alternatively, a
component may be defined inside a
\l{http://qt-project.org/doc/qt-5.0/qtqml/qml-qtquick2-component.html}
{Component} QML type.
component may be defined inside a \l{Component} QML type.
\row
\li Deploy configuration
......
......@@ -59,8 +59,7 @@
\QC provides two integrated visual editors, \QMLD and \QD.
To create intuitive, modern-looking, fluid user interfaces, you
can use \l{http://qt-project.org/doc/qt-5.0/qtquick/qtquick-index.html}
{Qt Quick}.
can use \l{Qt Quick}.
If you need a traditional user interface that is clearly
structured and enforces a platform look and feel, you can use
the integrated \QD. For more information, see
......
......@@ -55,8 +55,7 @@
process for development projects across different platforms. qmake
automates the generation of build configurations so that only a few lines
of information are needed to create each configuration. For more
information about qmake, see the
\l{http://qt-project.org/doc/qt-5.0/qtdoc/qmake-manual.html}{qmake Manual}.
information about qmake, see the \l{qmake Manual}.
You can modify the build and run settings for qmake projects in the
\gui Projects mode.
......@@ -327,11 +326,12 @@
Qt provides support for integration with OpenGL implementations on all
platforms, which allows you to display hardware accelerated 3D graphics
alongside a more conventional user interface. For more information, see
\l{http://qt-project.org/doc/qt-5.0/qtopengl/qtopengl-index.html}{Qt OpenGL}.
\l{Qt Gui#opengl-and-opengl-es-integration}{OpenGL and OpenGL ES integration}.
You can use the QGLShader class to compile OpenGL shaders written in the
You can use the QOpenGLShader class to compile OpenGL shaders written in the
OpenGL Shading Language (GLSL) and in the OpenGL/ES Shading Language
(GLSL/ES). QGLShader and QGLShaderProgram shelter you from the details of
(GLSL/ES). QOpenGLShader and QOpenGLShaderProgram shelter you from the
details of
compiling and linking vertex and fragment shaders.
You can use \QC code editor to write fragment and vertex shaders
......@@ -380,8 +380,7 @@
the root project and to add another project, such as a C++ library.
The wizard creates a project file (.pro) that defines a \c subdirs template
and the subproject that you add as a value of the
\l{http://qt-project.org/doc/qt-5.0/qtdoc/qmake-variable-reference.html#subdirs}
and the subproject that you add as a value of the \l{Variables#subdirs}
{SUBDIRS variable}. It also adds all the necessary files for the subproject.
To add more subprojects, right-click the project name in the \gui Projects
......
......@@ -90,8 +90,7 @@
\endlist
For more information about the project file settings, see
\l{http://qt-project.org/doc/qt-5.0/qtdoc/qmake-project-files.html#declaring-other-libraries}
{Declaring Other Libraries}.
\l{Declaring Other Libraries}.
\section1 Example of Adding Internal Libraries
......
......@@ -60,7 +60,7 @@
{shadow builds} are used to keep the build specific files separate
from the source. You can create separate versions of project files
to keep platform-dependent code separate. You can use qmake
\l{http://qt-project.org/doc/qt-5.0/qtdoc/qmake-tutorial.html#adding-platform-specific-source-files}
\l{Adding Platform Specific Source Files}
{scopes} to select the file to process depending on which platform
qmake is run on.
......
......@@ -72,8 +72,7 @@
field displays the location of the file on the development PC. The
\gui {Remote Directory} field displays the folder where the file is
installed on the device. Text in red color indicates that the information is
missing. Edit the qmake
\l{http://qt-project.org/doc/qt-5.0/qtdoc/qmake-variable-reference.html#installs}
missing. Edit the qmake \l{Variables#installs}
{INSTALLS variable} in the project .pro file to add the missing files.
When you run the application, \QC copies the necessary files to the device
......
......@@ -31,10 +31,10 @@
\title Creating a Qt Quick Application
This tutorial uses built-in QML types and illustrates basic concepts of
\l {http://qt-project.org/doc/qt-5.0/qtquick/qtquick-index.html}{Qt Quick}.
\l{Qt Quick}.
This tutorial describes how to use \QC to implement Qt states and transitions. We use
\l{http://qt-project.org/doc/qt-5.0/qtquick/animation.html}{Qt example code} to
\l{Animation}{Qt example code} to
create an application that displays a Qt logo that moves between three rectangles on the
page when you click them.
......
......@@ -91,8 +91,7 @@
\endlist
To create a graphical button that scales beautifully without using vector
graphics, use the \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-borderimage.html}
{Border Image} type. For more information, see
graphics, use the \l{BorderImage} type. For more information, see
\l{Creating Scalable Buttons and Borders}.
*/
......@@ -108,8 +107,7 @@
\title Creating Scalable Buttons and Borders
You can use the
\l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-borderimage.html}
{Border Image} type to display an image, such as a PNG file, as a border
\l{BorderImage} type to display an image, such as a PNG file, as a border
and a background.
Use two Border Image items and suitable graphics to make it look like the
......
......@@ -41,36 +41,32 @@
\list
\li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-borderimage.html}
{Border Image}
uses an image as a border or background.
\li \l{BorderImage} uses an image as a border or background.
\li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-image.html}{Image}
\li \l{Image}
adds a bitmap to the scene. You can stretch and tile images.
\li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-item.html}{Item}
\li \l{Item}
is the most basic of all visual types in QML. Even though it has no
visual appearance, it defines all the properties that are common
across visual types, such as the x and y position, width and height,
anchoring, and key handling.
\li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-rectangle.html}{Rectangle}
\li \l{Rectangle}
adds a rectangle that is painted with a solid fill color and an
optional border. You can also use the radius property to create
rounded rectangles.
\li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-text.html}{Text}
adds formatted read-only text.
\li \l{Text} adds formatted read-only text.
\li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-textedit.html}{Text Edit}
\li \l{TextEdit}
adds a single line of editable formatted text that can be validated.
\li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-textinput.html}{Text Input}
\li \l{TextInput}
adds a single line of editable plain text that can be validated.
\omit
\li \l{http://qt-project.org/doc/qt-5.0/qtwebkit/qml-qtwebkit3-webview.html}{Web View}
adds web content to a canvas.
\li \l{WebView} adds web content to a canvas.
\endomit
\endlist
......
......@@ -105,7 +105,7 @@
\section2 Setting the Stacking Order
The \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-item.html#z-prop}{z property} of an
The \l{Item#z-prop}{z property} of an
item determines its position in relation to its sibling items in the
type hierarchy. By default, items with a higher stacking value are
drawn on top of siblings with a lower stacking value. Items with the same
......@@ -334,8 +334,7 @@
transformations to an item. Each transformation is applied in order, one at
a time.
For more information on Transform types, see
\l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-transform.html}{Transform}.
For more information on Transform types, see \l{Transform}.
\section1 Adding States
......@@ -373,8 +372,7 @@
\endlist
The \gui State pane displays the different
\l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-state.html}{states}
The \gui State pane displays the different \l{State}{states}
of the component in the Qt Quick Designer.
\image qmldesigner-transitions.png "State pane"
......
......@@ -36,11 +36,9 @@
information for code completion and the semantic checks to work correctly.
When you write a QML module or use QML from a C++ application you typically
register new types with
\l{http://qt-project.org/doc/qt-5.0/qtqml/qqmlengine.html#qmlRegisterType}
{qmlRegisterType} or expose some class instances with
\l{http://qt-project.org/doc/qt-5.0/qtqml/qqmlcontext.html#setContextProperty}
{setContextProperty}. The \QC C++ code model now scans for these calls and
register new types with \l{QQmlEngine#qmlRegisterType-3}{qmlRegisterType()} or expose some
class instances with \l{QQmlContext::setContextProperty()}. The \QC C++
code model now scans for these calls and
tells the QML code model about them. This means that properties are
displayed during code completion and the JavaScript code checker does not
complain about unknown types. However, this works only when the source code
......@@ -55,8 +53,7 @@
For Qt 4.8 and later, one or more \c qmltypes files can be listed in the
\c qmldir file under the \c typeinfo header. These files will be read in
addition to \c{plugins.qmltypes}. For more information, see
\l{http://qt-project.org/doc/qt-5.0/qtqml/qtqml-modules-qmldir.html#writing-a-qmltypes-file}
{Writing a qmltypes File}.
\l{Writing a qmltypes File}.
\section1 Generating qmltypes Files
......
This diff is collapsed.
......@@ -48,8 +48,7 @@
\section1 Previewing Images
The Qt Quick Toolbar for images allows you to edit the properties of
\l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-borderimage.html}{Border Image}
and \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-image.html}{Image} items.
BorderImage and \l{Image} items.
You can scale and tile the images, replace them with other images,
preview them, and change the image margins.
......@@ -63,7 +62,7 @@
\section1 Formatting Text
The Qt Quick Toolbar for text allows you to edit the properties of
\l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-text.html}{Text} items.
\l{Text} items.
You can change the font family and size as well as text formatting, style,
alignment, and color.
......@@ -79,8 +78,7 @@
\section1 Previewing Animation
The Qt Quick Toolbar for animation allows you to edit the properties of
\l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-propertyanimation.html}
{PropertyAnimation} items and the items that inherit it. You can
PropertyAnimation items and the items that inherit it. You can
change the easing curve type and duration. For some curves, you can also
specify amplitude, period, and overshoot values.
......@@ -91,8 +89,7 @@
\section1 Editing Rectangles
The Qt Quick Toolbar for rectangles allows you to edit the properties of
\l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-rectangle.html}{Rectangle}
items. You can change the fill and border colors and add
\l{Rectangle} items. You can change the fill and border colors and add
gradients.
\image qml-toolbar-rectangle.png "Qt Quick Toolbar for rectangles"
......
......@@ -31,8 +31,7 @@
\title Creating a Qt Widget Based Application
This tutorial describes how to use \QC to create a small Qt application,
Text Finder. It is a simplified version of the Qt UI Tools
\l{http://qt-project.org/doc/qt-5.0/qtuitools/textfinder.html}{Text Finder
Text Finder. It is a simplified version of the Qt UI Tools \l{Text Finder
example}. The application user interface is constructed from Qt widgets by
using \QD. The application logic is written in C++ by using the code editor.
......@@ -198,7 +197,7 @@
\endlist
For more information about designing forms with \QD, see the
\l{http://qt-project.org/doc/qt-5.0/qtdesigner/qtdesigner-manual.html}{Qt Designer Manual}.
\l{Qt Designer Manual}.
\section2 Completing the Header File
......@@ -232,8 +231,7 @@
\li Add code to load a text file using QFile, read it with QTextStream,
and then display it on \c{textEdit} with
\l{http://qt-project.org/doc/qt-5.0/qtwidgets/qtextedit.html#plainText-prop}
{setPlainText()}.
\l{QTextEdit::setPlainText()}.
This is illustrated by the following code snippet:
\snippet textfinder/textfinder.cpp 0
......@@ -244,9 +242,7 @@
\snippet textfinder/textfinder.cpp 1
\li For the \c{on_findButton_clicked()} slot, add code to extract the
search string and use the
\l{http://qt-project.org/doc/qt-5.0/qtwidgets/qtextedit.html#find}{find()}
function
search string and use the \l{QTextEdit::find()} function
to look for the search string within the text file. This is
illustrated by the following code snippet:
......
......@@ -35,8 +35,7 @@
\image qtcreator-formedit.png
For more information about \QD, see the
\l{http://qt-project.org/doc/qt-5.0/qtdesigner/qtdesigner-manual.html}{Qt Designer Manual}.
For more information about \QD, see the \l{Qt Designer Manual}.
Generally, the integrated \QD contains the same functions as the standalone
\QD. The following sections describe the differences.
......
......@@ -41,8 +41,7 @@
and to change the default plugin path, see \l{How to Create Qt Plugins}.
For more information about how to create plugins for \QD, see
\l{http://qt-project.org/doc/qt-5.0/qtdesigner/designer-using-custom-widgets.html}
{Using Custom Widgets with Qt Designer}.
\l{Using Custom Widgets with Qt Designer}.
\section1 Locating Qt Designer Plugins
......@@ -75,8 +74,7 @@
\QC uses its own set of Qt Libraries located in the bundle, and therefore,
you need to configure the \QD plugins that you want to use with \QC.
Fore more information about how to deploy applications to Mac OS, see
\l{http://qt-project.org/doc/qt-5.0/qtdoc/deployment-mac.html}
{Deploying an Application on Mac OS X}.
\l{Deploying an Application on Mac OS X}.
The following example illustrates how to configure version 5.2.1 of the
\l{http://qwt.sourceforge.net/}{Qwt - Qt Widgets for Technical Applications}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment