aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorhjk <hjk@qt.io>2017-10-26 16:32:48 +0200
committerhjk <hjk@qt.io>2017-11-06 11:53:57 +0000
commit78513ecd8fcd1fd716d997ffe5d85b67e45fb6b5 (patch)
tree183e879f44979cfacb38ff3aee89038411f8d813 /doc
parent0e1953a0f447d643a602ecb82b55826dfca88882 (diff)
Debugger: Split Expressions view into dock of its own
Change-Id: Ie86a5bd72c3140219f925835a065d9f6a3ae0ea4 Task-number: QTCREATORBUG-19167 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Christian Stenger <christian.stenger@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/src/debugger/creator-debugger.qdoc56
-rw-r--r--doc/src/debugger/qtquick-debugging.qdoc19
-rw-r--r--doc/src/howto/creator-tips.qdoc15
3 files changed, 47 insertions, 43 deletions
diff --git a/doc/src/debugger/creator-debugger.qdoc b/doc/src/debugger/creator-debugger.qdoc
index 98b2d2d7be..7a569838d9 100644
--- a/doc/src/debugger/creator-debugger.qdoc
+++ b/doc/src/debugger/creator-debugger.qdoc
@@ -639,8 +639,9 @@
\endlist
- If the address is displayed in the \uicontrol {Locals and Expressions} view,
- you can select \uicontrol {Add Data Breakpoint at Object's Address} in the
+ If the address is displayed in the \uicontrol {Locals} or
+ \uicontrol {Expressions} view, you can select
+ \uicontrol {Add Data Breakpoint at Object's Address} in the
context menu to set the data breakpoint.
Data breakpoints will be disabled when the debugged program exits, as it
@@ -665,8 +666,8 @@
corresponding source locations are grayed out in the \uicontrol Stack view.
If you click a frame with a known source location, the text editor jumps to
- the corresponding location and updates the
- \uicontrol {Locals and Expressions} view, making it seem like the program
+ the corresponding location and updates the \uicontrol {Locals} and
+ \uicontrol {Expressions} views, making it seem like the program
was interrupted before entering the function.
To find out which QML file is causing a Qt Quick 2 application to crash,
@@ -676,28 +677,29 @@
should it find any. You can click a frame in the QML stack to open the QML
file in the editor.
- \section1 Locals and Expressions
+ \section1 Local Variables and Function Parameters
- The Locals and Expressions view consists of three parts: the
- \uicontrol Locals pane at the top, the \uicontrol {Return Value} pane in
- the middle, and the \uicontrol Expressions pane at the bottom. The
- \uicontrol {Return Value} and \uicontrol Expression panes are only visible
- if they are not empty.
+ The Locals view consists of two parts: the \uicontrol Locals pane at the top
+ and the \uicontrol {Return Value} pane at the bottom. The
+ \uicontrol {Return Value} is only visible if it is not empty.
- \image qtcreator-locals-expressions.png "Locals and Expressions view"
+ \image qtcreator-locals-expressions.png "Locals view"
Whenever a program stops under the control of the debugger, it retrieves
information about the topmost stack frame and displays it in the
- \uicontrol {Locals and Expressions} view. The \uicontrol Locals pane shows
+ \uicontrol {Locals} view. The \uicontrol Locals pane shows
information about parameters of the function in that frame as well as the
local variables. If the last operation in the debugger was returning from a
function after pressing \key {Shift+F11}, the \uicontrol {Return Value}
pane displays the value returned by the function.
+
+ \section1 Evaluating Expresssion
+
To compute values of arithmetic expressions or function calls, use
- expression evaluators in the \uicontrol Expressions pane. To insert a new
+ expression evaluators in the \uicontrol Expressions view. To insert a new
expression evaluator, either double-click on an empty part of the
- \uicontrol {Locals and Expressions} view, or select
+ \uicontrol {Expressions} or \uicontrol {Locals} view, or select
\uicontrol {Add New Expression Evaluator} from the context menu, or drag and
drop an expression from the code editor.
@@ -734,8 +736,8 @@
\li GDB and LLDB, and therefore \QC's debugger, also work for optimized
builds on Linux and \macos. Optimization can lead to re-ordering
of instructions or removal of some local variables, causing the
- \uicontrol {Locals and Expressions} view to show unexpected
- data.
+ \uicontrol {Locals} and \uicontrol {Expressions} view to show
+ unexpected data.
\row
\li The debug information provided by GCC does not include enough
information about the time when a variable is initialized.
@@ -747,8 +749,8 @@
\endtable
- The \uicontrol {Locals and Expressions} view also provides access to the
- most powerful feature of the debugger: comprehensive display of data
+ The \uicontrol {Locals} and \uicontrol {Expressions} views also provide access
+ to the most powerful feature of the debugger: comprehensive display of data
belonging to Qt's basic objects. For example, in case of QObject, instead of
displaying a pointer to some private data structure, you see a list of
children, signals and slots.
@@ -758,8 +760,8 @@
debugger displays access data for QFileInfo and provides access to the
"real" contents of QVariant.
- Right-click in the \uicontrol {Locals and Expressions} view to open a
- context menu that provides additional options for viewing data. The
+ Right-click in the \uicontrol {Locals} or the \uicontrol {Expressions} view
+ to open a context menu that provides additional options for viewing data. The
available options depend on the type of the current items, and are provided
by the \l{Using Debugging Helpers}{Debugging Helpers}. Typically,
string-like data, such as \c{QByteArray} and \c{std::string}, offer a
@@ -770,8 +772,8 @@
example, to expand all the values of QMap, select
\uicontrol {Change Value Display Format} > \uicontrol Compact.
- You can use the \uicontrol {Locals and Expressions} view to change the
- contents of variables of simple data types, for example, \c int, \c float,
+ You can use the \uicontrol {Locals} and \uicontrol {Expressions} view to change
+ the contents of variables of simple data types, for example, \c int, \c float,
\c QString and \c std::string when the program is interrupted. To do so,
click the \uicontrol Value column, modify the value with the inplace editor,
and press \key Enter (or \key Return).
@@ -798,7 +800,7 @@
\note Usually, you do not need this feature, because \QC provides you
with better ways to handle the task. For example, instead of using the GDB
\c print command from the command line, you can evaluate an expression in
- the \uicontrol {Locals and Expressions} view.
+ the \uicontrol {Expressions} view.
\section1 Debugging C++ Based Applications
@@ -932,8 +934,8 @@
\title Using Debugging Helpers
- Structured data, such as objects of \c class, \c struct, or \c union
- types, is displayed in the \uicontrol {Locals and Expressions} view as part
+ Structured data, such as objects of \c class, \c struct, or \c union types,
+ is displayed in the \uicontrol {Locals} and \uicontrol {Expressions} views as part
of a tree. To access sub-structures of the objects, expand the tree nodes.
The sub-structures are presented in their in-memory order, unless the
\uicontrol {Sort Members of Classes and Structs Alphabetically} option
@@ -970,8 +972,8 @@
\QC uses Python scripts to translate raw memory contents and type information
data from native debugger backends (GDB, LLDB, and CDB are currently supported)
- into the form presented to the user in the \uicontrol {Locals and Expressions}
- view.
+ into the form presented to the user in the \uicontrol {Locals} and
+ \uicontrol {Expressions} views.
Unlike GDB's
\l{https://sourceware.org/gdb/onlinedocs/gdb/Pretty-Printing.html#Pretty-Printing}
diff --git a/doc/src/debugger/qtquick-debugging.qdoc b/doc/src/debugger/qtquick-debugging.qdoc
index 3fbd535665..5862142c29 100644
--- a/doc/src/debugger/qtquick-debugging.qdoc
+++ b/doc/src/debugger/qtquick-debugging.qdoc
@@ -149,7 +149,10 @@
\li \l{Viewing Call Stack Trace}{Viewing call stack trace}
- \li \l{Locals and Expressions}{Viewing locals and expressions}
+ \li \l{Local Variables and Function Parameters}
+ {Viewing local variables and function parameters}
+
+ \li \l{Evaluating Expressions}{Evaluating expressions at run time}
\endlist
@@ -167,21 +170,21 @@
\section1 Applying QML Changes at Runtime
When you change property values in the \uicontrol {Debugger Console} or in the
- \uicontrol {Locals and Expressions} view, they are immediately updated in the running
- application, but not in the source code.
+ \uicontrol {Locals} or \uicontrol {Expression} view, they are immediately updated
+ in the running application, but not in the source code.
\section1 Inspecting Items
- While the application is running, you can use the
- \uicontrol {Locals and Expressions} view to explore the QML item structure.
+ While the application is running, you can use the \uicontrol {Locals}
+ and \uicontrol{Expressions} views to explore the QML item structure.
\image qml-observer-view.png "QML item tree"
To keep the application visible while you interact with the debugger, select
\uicontrol Debug > \uicontrol {Show Application on Top}.
- You can view a QML item in \uicontrol {Locals and Expressions} in the following
- ways:
+ You can view a QML item in \uicontrol {Locals} and \uicontrol {Expressions}
+ in the following ways:
\list
@@ -205,7 +208,7 @@
In the selection mode, you can click items in the running
application to jump to their definitions in the code. The properties of the
- selected item are displayed in the \uicontrol {Locals and Expressions} view.
+ selected item are displayed in the \uicontrol {Locals} view.
The \uicontrol Select tool will be enabled either if your application is
using Qt 5.7 or later, or if your application is using an earlier version
diff --git a/doc/src/howto/creator-tips.qdoc b/doc/src/howto/creator-tips.qdoc
index eea0f79c2b..5b0b5919ad 100644
--- a/doc/src/howto/creator-tips.qdoc
+++ b/doc/src/howto/creator-tips.qdoc
@@ -168,15 +168,14 @@
If an instance of a class is derived from QObject, and you would like to
find all other objects connected to one of your object's slots using
Qt's signals and slots mechanism, select \uicontrol Tools > \uicontrol Options
- > \uicontrol{Debugger} > \uicontrol{Locals and Expressions} >
- \uicontrol{Use Debugging Helper}.
+ > \uicontrol{Debugger} > \uicontrol{Locals} > \uicontrol{Use Debugging Helper}.
- In the \uicontrol{Locals and Expressions} view, expand the object's entry and open
+ In the \uicontrol{Locals} view, expand the object's entry and open
the slot in the \e slots subitem. The objects connected to this slot are
shown as children of the slot. This method works with signals too.
- For more information about the \uicontrol{Locals and Expressions} view, see
- \l{Locals and Expressions}.
+ For more information about the \uicontrol{Locals} view, see
+ \l{Local Variables and Function Parameters}.
\section1 Displaying Low Level Data
@@ -188,7 +187,7 @@
\list 1
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Debugger >
- \uicontrol{Locals and Expressions}.
+ \uicontrol{Locals}.
\li Uncheck the \uicontrol{Use Debugging Helper} checkbox.
@@ -216,8 +215,8 @@
\image qtcreator-pin-tooltip.png
Pinned tooltips are stored in the session. To close all pinned tooltips,
- select \uicontrol {Close Editor Tooltips} in the context menu in the \uicontrol {Locals
- and Expressions} view.
+ select \uicontrol {Close Editor Tooltips} in the context menu in the
+ \uicontrol {Locals} view.
\section1 Locating Files