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

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.include = input
macro.li = "\\o"
macro.0 = "\\\\0"
macro.b = "\\\\b"
macro.b = "\\bold"
macro.n = "\\\\n"
macro.r = "\\\\r"
macro.i = "\\o"
......
......@@ -2,17 +2,17 @@ macro.aacute.HTML = "&aacute;"
macro.Aring.HTML = "&Aring;"
macro.aring.HTML = "&aring;"
macro.Auml.HTML = "&Auml;"
macro.author = "\\bold{Author:}"
macro.author = "\\b{Author:}"
macro.br.HTML = "<br />"
macro.BR.HTML = "<br />"
macro.copyright.HTML = "&copy;"
macro.eacute.HTML = "&eacute;"
macro.gui = "\\bold"
macro.gui = "\\b"
macro.hr.HTML = "<hr />"
macro.iacute.HTML = "&iacute;"
macro.key = "\\bold"
macro.menu = "\\bold"
macro.note = "\\bold{Note:}"
macro.key = "\\b"
macro.menu = "\\b"
macro.note = "\\b{Note:}"
macro.oslash.HTML = "&oslash;"
macro.ouml.HTML = "&ouml;"
macro.QA = "Qt Assistant"
......
......@@ -49,14 +49,14 @@
\list
\o \l{Profiling QML Applications}{QML Profiler}
\li \l{Profiling QML Applications}{QML Profiler}
You can inspect binding evaluations, signal handling, and
painting operations when running QML code. This is useful for
identifying potential bottlenecks, especially in the evaluation
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
tool and find cache misses in the code by using the Callgrind tool.
......
......@@ -50,11 +50,11 @@
\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
......
......@@ -44,19 +44,19 @@
\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"
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"
button to view the results of the analysis in the
\gui {Analysis} view.
......@@ -135,19 +135,19 @@
\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"
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"
button to view the results of the analysis in the \gui Profile
view.
......@@ -209,11 +209,11 @@
\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
......@@ -224,10 +224,10 @@
\list
\o Number of conditional branches executed and related predictor misses
\li Number of conditional branches executed and related predictor misses
(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)
\endlist
......@@ -252,12 +252,12 @@
\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)}.
\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.
\endlist
......
......@@ -34,20 +34,20 @@
\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
\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.
\note To profile applications on devices, you must install Qt 4.7.4
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.
\o Select the
\li Select the
\inlineimage qtcreator-analyze-start-button.png
(\gui Start) button to start the application from the
QML Profiler.
......@@ -99,17 +99,17 @@
\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
......@@ -205,11 +205,11 @@
\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
......
......@@ -40,7 +40,7 @@
\list
\o OpenJDK Java Development Kit
\li OpenJDK Java Development Kit
To check whether you have OpenJDK installed, enter the following
command:
......@@ -51,7 +51,7 @@
\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
To check the Ant version, enter the following command on the command
......@@ -59,7 +59,7 @@
\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}
\endlist
......@@ -73,37 +73,37 @@
\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.
\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
(\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.
\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
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
\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
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 {Package configurations}. For more information about the
options you have, see
\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
information about the options you have, see
\l{Deploying Applications to Android Devices}.
......
......@@ -40,23 +40,23 @@
\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.
\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}.
\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
\o To remove a breakpoint, right-click it and select
\li To remove a breakpoint, right-click it and select
\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.
\image qtcreator-watcher.png
......
......@@ -109,33 +109,33 @@
\table
\header
\o Platform
\o Compiler
\o Native Debugger
\li Platform
\li Compiler
\li Native Debugger
\row
\o Linux
\o GCC, ICC
\o GDB
\li Linux
\li GCC, ICC
\li GDB
\row
\o Unix
\o GCC, ICC
\o GDB
\li Unix
\li GCC, ICC
\li GDB
\row
\o Mac OS X
\o GCC
\o Apple GDB, FSF GDB (experimental)
\li Mac OS X
\li GCC
\li Apple GDB, FSF GDB (experimental)
\row
\o Windows/MinGW
\o GCC
\o GDB
\li Windows/MinGW
\li GCC
\li GDB
\row
\o Windows/MSVC
\o Microsoft Visual C++ Compiler
\o Debugging Tools for Windows/CDB
\li Windows/MSVC
\li Microsoft Visual C++ Compiler
\li Debugging Tools for Windows/CDB
\row
\o Maemo, MeeGo
\o GCC
\o GDB
\li Maemo, MeeGo
\li GCC
\li GDB
\endtable
For more information on the debugger modes, see
......@@ -153,19 +153,19 @@
\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
available, parts relevant only when Python is not available, and
mixed code.
\o TermGdbAdapter debugs locally started processes that need a
\li TermGdbAdapter debugs locally started processes that need a
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
......@@ -178,11 +178,11 @@
\table
\header
\o Native Debugger
\o Notes
\li Native Debugger
\li Notes
\row
\o GDB
\o On Linux and Windows, use the Python-enabled GDB versions that
\li GDB
\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,
use the GDB provided with Xcode.
You can also build your own Python-enabled GDB. Follow the instructions in
......@@ -190,8 +190,8 @@
{Building GDB}.
\row
\o Debugging tools for Windows
\o To use this engine, you must install the
\li Debugging tools for Windows
\li To use this engine, you must install the
\e{Debugging tools for Windows}. You can download them from
\l{http://msdn.microsoft.com/en-us/windows/hardware/gg463009/}
{Download and Install Debugging Tools for Windows}.
......@@ -213,8 +213,8 @@
\l{Setting the Symbol Server in Windows}.
\row
\o Debugging tools for Mac OS X
\o The Qt binary distribution contains both debug and release
\li Debugging tools for Mac OS X
\li The Qt binary distribution contains both debug and release
variants of the libraries. But you have to explicitly tell the
runtime linker that you want to use the debug libraries even if
your application is compiled as debug, as release is the default
......@@ -250,12 +250,12 @@
\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}.
\o Select a directory where you want to store the cached information
\li Select a directory where you want to store the cached information
and click \gui OK.
Use a subfolder in a temporary directory, such as
......@@ -276,50 +276,50 @@
\list 1
\o To create a key for signing FSF GDB, select \gui {Keychain Access >
\li To create a key for signing FSF GDB, select \gui {Keychain Access >
Certificate Assistant > Create a Certificate}:
\list 1
\o In the \gui {Name} field, input \gui {fsfgdb} to replace
\li In the \gui {Name} field, input \gui {fsfgdb} to replace
the existing content.
\o In the \gui {Certificate Type} field, select
\li In the \gui {Certificate Type} field, select
\gui {Code Signing}.
\o Select the \gui {Let me override defaults} check box.
\li Select the \gui {Let me override defaults} check box.
\o Select \gui Continue, and follow the instructions of the
\li Select \gui Continue, and follow the instructions of the
wizard (use the default settings), until the \gui {Specify a
Location For The Certificate} dialog opens.
\o In the \gui Keychain field, select \gui System.
\li In the \gui Keychain field, select \gui System.
\o Select \gui {Keychain Access > System}, and locate the
\li Select \gui {Keychain Access > System}, and locate the
certificate.
\o Double click the certificate to view certificate information.
\li Double click the certificate to view certificate information.
\o In the \gui Trust section, select \gui {Always Trust} in the
\li In the \gui Trust section, select \gui {Always Trust} in the
\gui {When using this certificate} field, and then close
the dialog.
\endlist
\o To sign the binary, enter the following command in the terminal:
\li To sign the binary, enter the following command in the terminal:
\code
codesign -f -s "fsfgdb" $INSTALL_LOCATION/fsfgdb
\endcode
\o In \QC, select \gui {Qt Creator > Preferences > Build & Run >
\li In \QC, select \gui {Qt Creator > Preferences > Build & Run >
Kits} > \gui Add to create a kit that uses FSF GDB.
\o In the \gui Debugger field, specify the path to FSF GDB
\li In the \gui Debugger field, specify the path to FSF GDB
(\c $HOME/gdb72/bin/fsfgdb, but with an explicit value for
\c $HOME).
\o To use the debugger, add the kit in the \gui {Build Settings}
\li To use the debugger, add the kit in the \gui {Build Settings}
of the project.
\endlist
......
This diff is collapsed.
......@@ -43,7 +43,7 @@
\list 1
\o To look at the code that starts a new game, place a breakpoint in
\li To look at the code that starts a new game, place a breakpoint in
samegame.qml by clicking between the line number and the window
border on the line where where the \c startNewGame() function is
called (1).
......@@ -53,19 +53,19 @@
The red circle indicates that a breakpoint is now set on that line
number.
\o Select \gui {Debug > Start Debugging > Start Debugging} or press
\li Select \gui {Debug > Start Debugging > Start Debugging} or press
\key{F5}.
\o Once the Same Game application starts, click the \gui {New Game}
\li Once the Same Game application starts, click the \gui {New Game}
button to start a new game.
\o When the debugger hits the breakpoint, it interrupts the
\li When the debugger hits the breakpoint, it interrupts the
application. \QC displays the nested function calls leading to the
current position as a call stack trace (1).
\image qtquick-example-setting-breakpoint2.png
\o Click the
\li Click the
\inlineimage qtcreator-debug-button-step-into.png
(\gui {Step Into}) button on the toolbar or press \key F11 to step
into the code in the stack. The samegame.js file opens in the code
......@@ -73,38 +73,38 @@
\image qtquick-example-stack.png
\o Examine the local variables in the \gui {Locals and Expressions}
\li Examine the local variables in the \gui {Locals and Expressions}
view. Step through the code to see how the information changes in
the view.
\o Add a breakpoint at the end of the \c {startNewGame()} function, and
\li Add a breakpoint at the end of the \c {startNewGame()} function, and
click \inlineimage qtcreator-debugging-continue.png
(\gui Continue) to hit the breakpoint.
\image qtquick-example-setting-breakpoint3.png
\o To execute JavaScript commands in the current context, select the
\li To execute JavaScript commands in the current context, select the
\gui {Console} tab.
\o To change the score to 1000, enter \c{gameCanvas.score = 1000}
\li To change the score to 1000, enter \c{gameCanvas.score = 1000}
in the console.
\image qtquick-example-script-console.png
\o To remove a breakpoint, right-click it and select
\li To remove a breakpoint, right-click it and select
\gui {Delete Breakpoint}.
\o Select the \gui {Locals and Expressions} tab to explore the object
\li Select the \gui {Locals and Expressions} tab to explore the object
structure at runtime:
\image qtquick-example-qml-inspector.png
\o Click
\li Click
\inlineimage qml-inspector-app-on-top.png
(\gui {Show Application on Top}) to keep the application visible
while you interact with the debugger.
\o Click
\li Click
\inlineimage qml-inspector-select-button.png
(\gui Select) to activate selection mode and then click the
\gui {Quit} button to move into the \gui ButtonLabel component
......@@ -112,7 +112,7 @@
\image qtquick-example-property-values.png
\o In the \gui {Locals and Expressions} view, double-click the value of
\li In the \gui {Locals and Expressions} view, double-click the value of
the \c text property to change it temporarily from \gui {Quit} to
\gui {End Game}.
......
......@@ -50,11 +50,11 @@
\list 1
\o In \gui Projects mode \gui {Run Settings}, select the
\li In \gui Projects mode \gui {Run Settings}, select the
\gui {Enable QML} check box in the \gui {Debugger Settings} to
enable QML debugging.
\o For Qt 4.7, compile the QML Inspector debugging helper. For more information,
\li For Qt 4.7, compile the QML Inspector debugging helper. For more information,
see \l{Debugging Helpers for QML}.
\endlist
......@@ -63,7 +63,7 @@
\list 1
\o Debugging is enabled by default for Qt 4.8, or later. For Qt 4.7,
\li Debugging is enabled by default for Qt 4.8, or later. For Qt 4.7,
select \gui Projects, and then select the
\gui {Enable QML debugging} check box in the \gui qmake section
in \gui {Build Steps}.
......@@ -79,14 +79,14 @@
functions. Therefore, you must make sure that the port is properly
protected by a firewall.
\o In the \gui {Run Settings}, \gui {Debugger Settings} section, select
\li In the \gui {Run Settings}, \gui {Debugger Settings} section, select
the \gui {Enable QML} check box to enable
QML debugging.
\o Select \gui {Build > Rebuild Project} to clean and rebuild the
\li Select \gui {Build > Rebuild Project} to clean and rebuild the
project.
\o To debug applications on devices, check that Qt 4.7.4, or later,
\li To debug applications on devices, check that Qt 4.7.4, or later,
libraries are installed on the device and
\l{Running on Multiple Platforms}{select the corresponding kit for the device}
before you start debugging.
......@@ -110,14 +110,14 @@