Skip to content
Snippets Groups Projects
Commit 945f5cd0 authored by Oswald Buddenhagen's avatar Oswald Buddenhagen
Browse files

doc fixes

parent fa41f1e6
No related branches found
No related tags found
No related merge requests found
...@@ -1571,9 +1571,9 @@ ...@@ -1571,9 +1571,9 @@
The main.cpp file opens in the editor. The main.cpp file opens in the editor.
\endlist \endlist
You can enter only a part of a string you are searching for. As you type, It is also possible to enter only a part of a search string.
the locator shows the occurrences of that string regardless of where in the As you type, the locator shows the occurrences of that string regardless
name of an item it appears. of where in the name of an item it appears.
To narrow down the search results, you can use the following wildcard To narrow down the search results, you can use the following wildcard
characters: characters:
...@@ -2068,14 +2068,14 @@ ...@@ -2068,14 +2068,14 @@
use Debugging Helpers also for user defined types. All that is needed is use Debugging Helpers also for user defined types. All that is needed is
to define one Python function per user defined type in .gdbinit. to define one Python function per user defined type in .gdbinit.
The function's name has to be qdump__NS__Foo where NS::Foo is the class The function's name has to be qdump__NS__Foo where NS::Foo is the class
or class template to be examined. Nested namespaces are possible. or class template to be examined. Nested namespaces are possible.
Qt Creator's debugger integration will call this function whenever it Qt Creator's debugger integration will call this function whenever it
wants to display an object of this type. The function gets passed two wants to display an object of this type. The function gets passed two
parameters, 'd' of type 'Dumper', and 'item' of type 'Item'. The function parameters, 'd' of type 'Dumper', and 'item' of type 'Item'. The function
itself has to feed the Dumper object with certain information that itself has to feed the Dumper object with certain information which is
are used to build up the object and it's children's display in the used to build up the object and its children's display in the
Locals-and-Watchers view. Locals-and-Watchers view.
...@@ -2156,7 +2156,7 @@ ...@@ -2156,7 +2156,7 @@
a complete framework to take care of the 'iname' and 'addr' fields, a complete framework to take care of the 'iname' and 'addr' fields,
to handle children of simple types, references, to handle children of simple types, references,
pointers, enums, known and unknown structs as well as some pointers, enums, known and unknown structs as well as some
convenience method to handle common situations. convenience methods to handle common situations.
The 'Dumper' members are the following: The 'Dumper' members are the following:
...@@ -2186,7 +2186,7 @@ ...@@ -2186,7 +2186,7 @@
\o \gui{beginChildren(self, numChild_ = 1, childType_ = None, childNumChild_ = None)} \o \gui{beginChildren(self, numChild_ = 1, childType_ = None, childNumChild_ = None)}
- Starts writing a list of \a numChild children, with type - Starts writing a list of \a numChild children, with type
\a childType_ and \a childNumChild grandchildren each. If \a numChild_ \a childType_ and \a childNumChild_ grandchildren each. If \a numChild_
is a list of two integers, the first one specifies the actual number is a list of two integers, the first one specifies the actual number
of children and the second the maximum number of children to print. of children and the second the maximum number of children to print.
...@@ -2214,7 +2214,7 @@ ...@@ -2214,7 +2214,7 @@
\o \gui{putValue(self, value, encoding = None)} - Append a file \c {value='...'}, \o \gui{putValue(self, value, encoding = None)} - Append a file \c {value='...'},
optionally followed by a field \c {valueencoding='...'}. The \a value optionally followed by a field \c {valueencoding='...'}. The \a value
needs to be convertiable to a string entirely consisting of needs to be convertible to a string entirely consisting of
alphanumerical values. The \a encoding parameter can be used to alphanumerical values. The \a encoding parameter can be used to
specify the encoding in case the real value had to be encoded in some specify the encoding in case the real value had to be encoded in some
way to meet the alphanumerical-only requirement. way to meet the alphanumerical-only requirement.
...@@ -2275,9 +2275,9 @@ ...@@ -2275,9 +2275,9 @@
self.endHash() self.endHash()
\endcode \endcode
\o \gui{pushOutput(self)} - Moves output string to a safe location \o \gui{pushOutput(self)} - Moves the output string to a safe location
from with it will be send to the frontend even if further operations from with it will be sent to the frontend even if further operations
raise exception. raise an exception.
\o \gui{putCallItem(self, name, item, func)} - \o \gui{putCallItem(self, name, item, func)} -
Uses gdb to call the function \a func on the value specified by Uses gdb to call the function \a func on the value specified by
...@@ -2297,7 +2297,7 @@ ...@@ -2297,7 +2297,7 @@
\o \gui{safePutItemHelper(self, item)} - Calls \c putItemHelper(self, item). \o \gui{safePutItemHelper(self, item)} - Calls \c putItemHelper(self, item).
If an exception is raised, catch it, and replace all output produced by If an exception is raised, catch it, and replace all output produced by
\c putItemHelper by \code \c putItemHelper with the output of \code
self.putName(item.name) self.putName(item.name)
self.putValue("<invalid>") self.putValue("<invalid>")
self.putType(str(item.value.type)) self.putType(str(item.value.type))
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment