Commit 419c6de7 authored by Leena Miettinen's avatar Leena Miettinen Committed by Oswald Buddenhagen
Browse files

Doc: replace deprecated QDoc commands



The \i and \o commands were replaced with \li and
\bold was replaced with \b in QDoc for Qt 5.

The \input command was replaced with \include in the docs.

Change-Id: I257d1bebb8ebc739ca20e0d29fcf0406ecb14534
Reviewed-by: default avatarOswald Buddenhagen <oswald.buddenhagen@digia.com>
parent 276320ca
alias.i = e alias.i = e
alias.include = input
macro.li = "\\o"
macro.0 = "\\\\0" macro.0 = "\\\\0"
macro.b = "\\\\b" macro.b = "\\bold"
macro.n = "\\\\n" macro.n = "\\\\n"
macro.r = "\\\\r" macro.r = "\\\\r"
macro.i = "\\o" macro.i = "\\o"
......
...@@ -2,17 +2,17 @@ macro.aacute.HTML = "&aacute;" ...@@ -2,17 +2,17 @@ macro.aacute.HTML = "&aacute;"
macro.Aring.HTML = "&Aring;" macro.Aring.HTML = "&Aring;"
macro.aring.HTML = "&aring;" macro.aring.HTML = "&aring;"
macro.Auml.HTML = "&Auml;" macro.Auml.HTML = "&Auml;"
macro.author = "\\bold{Author:}" macro.author = "\\b{Author:}"
macro.br.HTML = "<br />" macro.br.HTML = "<br />"
macro.BR.HTML = "<br />" macro.BR.HTML = "<br />"
macro.copyright.HTML = "&copy;" macro.copyright.HTML = "&copy;"
macro.eacute.HTML = "&eacute;" macro.eacute.HTML = "&eacute;"
macro.gui = "\\bold" macro.gui = "\\b"
macro.hr.HTML = "<hr />" macro.hr.HTML = "<hr />"
macro.iacute.HTML = "&iacute;" macro.iacute.HTML = "&iacute;"
macro.key = "\\bold" macro.key = "\\b"
macro.menu = "\\bold" macro.menu = "\\b"
macro.note = "\\bold{Note:}" macro.note = "\\b{Note:}"
macro.oslash.HTML = "&oslash;" macro.oslash.HTML = "&oslash;"
macro.ouml.HTML = "&ouml;" macro.ouml.HTML = "&ouml;"
macro.QA = "Qt Assistant" macro.QA = "Qt Assistant"
......
...@@ -49,14 +49,14 @@ ...@@ -49,14 +49,14 @@
\list \list
\o \l{Profiling QML Applications}{QML Profiler} \li \l{Profiling QML Applications}{QML Profiler}
You can inspect binding evaluations, signal handling, and You can inspect binding evaluations, signal handling, and
painting operations when running QML code. This is useful for painting operations when running QML code. This is useful for
identifying potential bottlenecks, especially in the evaluation identifying potential bottlenecks, especially in the evaluation
of bindings. of bindings.
\o \l{Using Valgrind Code Analysis Tools}{Valgrind Code Analysis Tools} \li \l{Using Valgrind Code Analysis Tools}{Valgrind Code Analysis Tools}
You can detect problems in memory management by using the Memcheck You can detect problems in memory management by using the Memcheck
tool and find cache misses in the code by using the Callgrind tool. tool and find cache misses in the code by using the Callgrind tool.
......
...@@ -50,11 +50,11 @@ ...@@ -50,11 +50,11 @@
\list \list
\o \l{Detecting Memory Leaks} \li \l{Detecting Memory Leaks}
\o \l{Profiling Function Execution} \li \l{Profiling Function Execution}
\o \l{Running Valgrind Tools Remotely} \li \l{Running Valgrind Tools Remotely}
\endlist \endlist
......
...@@ -44,19 +44,19 @@ ...@@ -44,19 +44,19 @@
\list 1 \list 1
\o In the \gui Projects mode, select a debug build configuration. \li In the \gui Projects mode, select a debug build configuration.
\o Select \gui Analyze to open the \gui Analyze mode. \li Select \gui Analyze to open the \gui Analyze mode.
\o Select \gui {Analyze Memory} on the toolbar. \li Select \gui {Analyze Memory} on the toolbar.
\o Select the \li Select the
\inlineimage qtcreator-analyze-start-button.png "Start button" \inlineimage qtcreator-analyze-start-button.png "Start button"
button to start the application. button to start the application.
\o Use the application to analyze it. \li Use the application to analyze it.
\o Select the \li Select the
\inlineimage qtcreator-debug-button-stop.png "Stop button" \inlineimage qtcreator-debug-button-stop.png "Stop button"
button to view the results of the analysis in the button to view the results of the analysis in the
\gui {Analysis} view. \gui {Analysis} view.
...@@ -135,19 +135,19 @@ ...@@ -135,19 +135,19 @@
\list 1 \list 1
\o In the \gui Projects mode, select a release build configuration. \li In the \gui Projects mode, select a release build configuration.
\o Select \gui Analyze to open the \gui Analyze mode. \li Select \gui Analyze to open the \gui Analyze mode.
\o Select \gui Profile on the toolbar. \li Select \gui Profile on the toolbar.
\o Select the \li Select the
\inlineimage qtcreator-analyze-start-button.png "Start button" \inlineimage qtcreator-analyze-start-button.png "Start button"
button to start the application. button to start the application.
\o Use the application to analyze it. \li Use the application to analyze it.
\o Select the \li Select the
\inlineimage qtcreator-debug-button-stop.png "Stop button" \inlineimage qtcreator-debug-button-stop.png "Stop button"
button to view the results of the analysis in the \gui Profile button to view the results of the analysis in the \gui Profile
view. view.
...@@ -209,11 +209,11 @@ ...@@ -209,11 +209,11 @@
\list \list
\o Cache misses on instruction reads (I1mr/I2mr) \li Cache misses on instruction reads (I1mr/I2mr)
\o Data read accesses (Dr) and related cache misses (D1mr/D2mr) \li Data read accesses (Dr) and related cache misses (D1mr/D2mr)
\o Data write accesses (Dw) and related cache misses (D1mw/D2mw) \li Data write accesses (Dw) and related cache misses (D1mw/D2mw)
\endlist \endlist
...@@ -224,10 +224,10 @@ ...@@ -224,10 +224,10 @@
\list \list
\o Number of conditional branches executed and related predictor misses \li Number of conditional branches executed and related predictor misses
(Bc/Bcm) (Bc/Bcm)
\o Executed indirect jumps and related misses of the jump address \li Executed indirect jumps and related misses of the jump address
predictor (Bi/Bim) predictor (Bi/Bim)
\endlist \endlist
...@@ -252,12 +252,12 @@ ...@@ -252,12 +252,12 @@
\list 1 \list 1
\o Select \gui {Analyze > Valgrind Memory Analyzer (External)} or \li Select \gui {Analyze > Valgrind Memory Analyzer (External)} or
\gui {Valgrind Function Profiler (External)}. \gui {Valgrind Function Profiler (External)}.
\image qtcreator-valgrind-remote-settings.png "Start Analyzer dialog" \image qtcreator-valgrind-remote-settings.png "Start Analyzer dialog"
\o Specify the application to run and analyze, and the \l{glossary-buildandrun-kit}{kit} \li Specify the application to run and analyze, and the \l{glossary-buildandrun-kit}{kit}
to use. to use.
\endlist \endlist
......
...@@ -34,20 +34,20 @@ ...@@ -34,20 +34,20 @@
\list 1 \list 1
\o To be able to profile an application, you must set up QML debugging \li To be able to profile an application, you must set up QML debugging
for the project. For more information, see for the project. For more information, see
\l{Setting Up QML Debugging}. \l{Setting Up QML Debugging}.
\o In the \gui Projects mode, select Qt 4.7.4 in the \gui {Qt version} \li In the \gui Projects mode, select Qt 4.7.4 in the \gui {Qt version}
field. field.
\note To profile applications on devices, you must install Qt 4.7.4 \note To profile applications on devices, you must install Qt 4.7.4
or later libraries on them. or later libraries on them.
\o Select \gui {Analyze > QML Profiler} to profile the current \li Select \gui {Analyze > QML Profiler} to profile the current
application. application.
\o Select the \li Select the
\inlineimage qtcreator-analyze-start-button.png \inlineimage qtcreator-analyze-start-button.png
(\gui Start) button to start the application from the (\gui Start) button to start the application from the
QML Profiler. QML Profiler.
...@@ -99,17 +99,17 @@ ...@@ -99,17 +99,17 @@
\list \list
\o Painting operations \li Painting operations
\o Compiling the QML sources \li Compiling the QML sources
\o Creating elements \li Creating elements
\o Binding evaluations \li Binding evaluations
\o Signal handling \li Signal handling
\o Summary of the recorded period \li Summary of the recorded period
\endlist \endlist
...@@ -205,11 +205,11 @@ ...@@ -205,11 +205,11 @@
\list 1 \list 1
\o Select \gui {Projects > Run}. \li Select \gui {Projects > Run}.
\o In \gui {Run Environment}, click \gui Add. \li In \gui {Run Environment}, click \gui Add.
\o Add the QML_DISABLE_OPTIMIZER variable and set its value to 1. \li Add the QML_DISABLE_OPTIMIZER variable and set its value to 1.
\endlist \endlist
......
...@@ -40,7 +40,7 @@ ...@@ -40,7 +40,7 @@
\list \list
\o OpenJDK Java Development Kit \li OpenJDK Java Development Kit
To check whether you have OpenJDK installed, enter the following To check whether you have OpenJDK installed, enter the following
command: command:
...@@ -51,7 +51,7 @@ ...@@ -51,7 +51,7 @@
\c {sudo apt-get install openjdk-6-jdk} \c {sudo apt-get install openjdk-6-jdk}
\o \l{http://ant.apache.org/bindownload.cgi}{Apache Ant} 1.8.0, or \li \l{http://ant.apache.org/bindownload.cgi}{Apache Ant} 1.8.0, or
later later
To check the Ant version, enter the following command on the command To check the Ant version, enter the following command on the command
...@@ -59,7 +59,7 @@ ...@@ -59,7 +59,7 @@
\c {ant -version} \c {ant -version}
\o \l{http://necessitas.kde.org/necessitas/necessitas_sdk_installer.php} \li \l{http://necessitas.kde.org/necessitas/necessitas_sdk_installer.php}
{Necessitas SDK} {Necessitas SDK}
\endlist \endlist
...@@ -73,37 +73,37 @@ ...@@ -73,37 +73,37 @@
\list 1 \list 1
\o Select \gui Tools > \gui Options > \gui {Build & Run} > \li Select \gui Tools > \gui Options > \gui {Build & Run} >
\gui {Qt Versions} > \gui Add to add Qt for Android. \gui {Qt Versions} > \gui Add to add Qt for Android.
\o In the \gui {qmake location} field, add the \c qmake path from the \li In the \gui {qmake location} field, add the \c qmake path from the
Qt for Android SDK Qt for Android SDK
(\c {/opt/necessitas/Android/<qtversion>/bin/qmake} by default). (\c {/opt/necessitas/Android/<qtversion>/bin/qmake} by default).
\o Select \gui Tools > \gui Options > \gui Android to view and edit \li Select \gui Tools > \gui Options > \gui Android to view and edit
paths to the required software. paths to the required software.
\image qtcreator-options-android.png "Android options" \image qtcreator-options-android.png "Android options"
\o Select \gui Tools > \gui Options > \gui {Build & Run} > \li Select \gui Tools > \gui Options > \gui {Build & Run} >
\gui {Qt Versions} and build the GDB Helper to make the debugging \gui {Qt Versions} and build the GDB Helper to make the debugging
output for Qt specific constructs clean and easy to read. output for Qt specific constructs clean and easy to read.
\o To build the GDB Helper, select Qt for Android, select \gui Details \li To build the GDB Helper, select Qt for Android, select \gui Details
in the \gui Helpers section, and then select \gui Build in the in the \gui Helpers section, and then select \gui Build in the
\gui {GDB Helper} field. \gui {GDB Helper} field.
\o Select \gui {Start Android AVD Manager} to create Android virtual \li Select \gui {Start Android AVD Manager} to create Android virtual
devices (AVD) that enable you emulate device hardware and software devices (AVD) that enable you emulate device hardware and software
on the Android Emulator. on the Android Emulator.
\o To specify information for the Android manifest file, select \li To specify information for the Android manifest file, select
\gui Projects > \gui Run, and then select \gui Details to view the \gui Projects > \gui Run, and then select \gui Details to view the
\gui {Package configurations}. For more information about the \gui {Package configurations}. For more information about the
options you have, see options you have, see
\l{Specifying Run Settings for Android Devices}. \l{Specifying Run Settings for Android Devices}.
\o To specify settings for deploying applications to Android, select \li To specify settings for deploying applications to Android, select
\gui Details to view the \gui {Deploy configurations}. For more \gui Details to view the \gui {Deploy configurations}. For more
information about the options you have, see information about the options you have, see
\l{Deploying Applications to Android Devices}. \l{Deploying Applications to Android Devices}.
......
...@@ -40,23 +40,23 @@ ...@@ -40,23 +40,23 @@
\list 1 \list 1
\o Click in between the line number and the window border on the line \li Click in between the line number and the window border on the line
where we change the cursor position to set a breakpoint. where we change the cursor position to set a breakpoint.
\image qtcreator-setting-breakpoint1.png \image qtcreator-setting-breakpoint1.png
\o Select \gui{Debug > Start Debugging > Start Debugging} or press \li Select \gui{Debug > Start Debugging > Start Debugging} or press
\key{F5}. \key{F5}.
\o To view the breakpoint, click the \gui{Breakpoints} tab. \li To view the breakpoint, click the \gui{Breakpoints} tab.
\image qtcreator-setting-breakpoint2.png \image qtcreator-setting-breakpoint2.png
\o To remove a breakpoint, right-click it and select \li To remove a breakpoint, right-click it and select
\gui{Delete Breakpoint}. \gui{Delete Breakpoint}.
\o To view the base classes and data members of the TextFinder class, \li To view the base classes and data members of the TextFinder class,
go to the \gui{Locals and Expressions} view. go to the \gui{Locals and Expressions} view.
\image qtcreator-watcher.png \image qtcreator-watcher.png
......
...@@ -109,33 +109,33 @@ ...@@ -109,33 +109,33 @@
\table \table
\header \header
\o Platform \li Platform
\o Compiler \li Compiler
\o Native Debugger \li Native Debugger
\row \row
\o Linux \li Linux
\o GCC, ICC \li GCC, ICC
\o GDB \li GDB
\row \row
\o Unix \li Unix
\o GCC, ICC \li GCC, ICC
\o GDB \li GDB
\row \row
\o Mac OS X \li Mac OS X
\o GCC \li GCC
\o Apple GDB, FSF GDB (experimental) \li Apple GDB, FSF GDB (experimental)
\row \row
\o Windows/MinGW \li Windows/MinGW
\o GCC \li GCC
\o GDB \li GDB
\row \row
\o Windows/MSVC \li Windows/MSVC
\o Microsoft Visual C++ Compiler \li Microsoft Visual C++ Compiler
\o Debugging Tools for Windows/CDB \li Debugging Tools for Windows/CDB
\row \row
\o Maemo, MeeGo \li Maemo, MeeGo
\o GCC \li GCC
\o GDB \li GDB
\endtable \endtable
For more information on the debugger modes, see For more information on the debugger modes, see
...@@ -153,19 +153,19 @@ ...@@ -153,19 +153,19 @@
\list \list
\o PlainGdbAdapter debugs locally started GUI processes. It is \li PlainGdbAdapter debugs locally started GUI processes. It is
physically split into parts that are relevant only when Python is physically split into parts that are relevant only when Python is
available, parts relevant only when Python is not available, and available, parts relevant only when Python is not available, and
mixed code. mixed code.
\o TermGdbAdapter debugs locally started processes that need a \li TermGdbAdapter debugs locally started processes that need a
console. console.
\o AttachGdbAdapter debugs local processes started outside \QC. \li AttachGdbAdapter debugs local processes started outside \QC.
\o CoreGdbAdapter debugs core files generated from crashes. \li CoreGdbAdapter debugs core files generated from crashes.
\o RemoteGdbAdapter interacts with the GDB server running on Linux. \li RemoteGdbAdapter interacts with the GDB server running on Linux.
\endlist \endlist
...@@ -178,11 +178,11 @@ ...@@ -178,11 +178,11 @@
\table \table
\header \header
\o Native Debugger \li Native Debugger
\o Notes \li Notes
\row \row
\o GDB \li GDB
\o On Linux and Windows, use the Python-enabled GDB versions that \li On Linux and Windows, use the Python-enabled GDB versions that
are installed when you install \QC and Qt SDK. On Mac OS X, are installed when you install \QC and Qt SDK. On Mac OS X,
use the GDB provided with Xcode. use the GDB provided with Xcode.
You can also build your own Python-enabled GDB. Follow the instructions in You can also build your own Python-enabled GDB. Follow the instructions in
...@@ -190,8 +190,8 @@ ...@@ -190,8 +190,8 @@
{Building GDB}. {Building GDB}.
\row \row
\o Debugging tools for Windows \li Debugging tools for Windows
\o To use this engine, you must install the \li To use this engine, you must install the
\e{Debugging tools for Windows}. You can download them from \e{Debugging tools for Windows}. You can download them from
\l{http://msdn.microsoft.com/en-us/windows/hardware/gg463009/} \l{http://msdn.microsoft.com/en-us/windows/hardware/gg463009/}
{Download and Install Debugging Tools for Windows}. {Download and Install Debugging Tools for Windows}.
...@@ -213,8 +213,8 @@ ...@@ -213,8 +213,8 @@
\l{Setting the Symbol Server in Windows}. \l{Setting the Symbol Server in Windows}.
\row \row
\o Debugging tools for Mac OS X \li Debugging tools for Mac OS X
\o The Qt binary distribution contains both debug and release \li The Qt binary distribution contains both debug and release
variants of the libraries. But you have to explicitly tell the variants of the libraries. But you have to explicitly tell the
runtime linker that you want to use the debug libraries even if runtime linker that you want to use the debug libraries even if
your application is compiled as debug, as release is the default your application is compiled as debug, as release is the default
...@@ -250,12 +250,12 @@ ...@@ -250,12 +250,12 @@
\list 1 \list 1
\o Select \gui Tools > \gui Options > \gui Debugger > \gui CDB. \li Select \gui Tools > \gui Options > \gui Debugger > \gui CDB.
\o In the \gui {Symbol paths} field, open the \gui Insert menu \li In the \gui {Symbol paths} field, open the \gui Insert menu
and select \gui{Symbol Server}. and select \gui{Symbol Server}.
\o Select a directory where you want to store the cached information