Commit 1c74480e authored by Leena Miettinen's avatar Leena Miettinen

Doc: use QDoc commands correctly in Debugging Helpers

Use \gui only for text that appears in the Qt Creator UI.
Use \c for code.

Change-Id: I263d7a6dae5ef77469c561b40847157b833e2016
Reviewed-by: default avatarhjk <hjk121@nokiamail.com>
parent 659b9987
......@@ -986,13 +986,13 @@
]}"
\endcode
The value of the \gui{iname} field is the internal name of the object,
The value of the \c iname field is the internal name of the object,
constituting a dot-separated list of identifiers, corresponding to the
position of the object's representation in the view. If it is not
present, is it generated by concatenating the parent object's iname,
a dot, and a sequential number.
The value of the\gui{name} field is displayed in the \gui{name} column
The value of the \c name field is displayed in the \gui{Name} column
of the view. If it is not specified, a simple number in brackets
is used instead.
......@@ -1003,44 +1003,44 @@
enums, known and unknown structs as well as some convenience functions to
handle common situations.
The member functions of the \gui{Dumper} class are the following:
The member functions of the \c Dumper class are the following:
\list
\li \gui{__init__(self)} - Initializes the output to an empty string and
\li \c{__init__(self)} - Initializes the output to an empty string and
empties the child stack. This should not be used in user code.
\li \gui{put(self, value)} - Low level function to directly append to the
\li \c{put(self, value)} - Low level function to directly append to the
output string. That is also the fastest way to append output.
\li \gui{putField(self, name, value)} - Appends a name='value' field.
\li \c{putField(self, name, value)} - Appends a \c{name='value'} field.
\li \gui{childRange(self)} - Returns the range of children specified in
\li \c{childRange(self)} - Returns the range of children specified in
the current \c Children scope.
\li \gui{putItemCount(self, count)} - Appends a field
\li \c{putItemCount(self, count)} - Appends a field
\c {value='<%d items'} to the output.
\li \gui{putEllipsis(self)} - Appends fields
\li \c{putEllipsis(self)} - Appends fields
\c {'{name="<incomplete>",value="",type="",numchild="0"}'}. This is
automatically done by \c endChildren if the number of children to
print is smaller than the number of actual children.
\li \gui{putName(self, name)} - Appends a \c {name=''} field.
\li \c{putName(self, name)} - Appends a \c {name=''} field.
\li \gui{putType(self, type, priority=0)} - Appends a field \c {type=''}
\li \c{putType(self, type, priority=0)} - Appends a field \c {type=''}
unless the \a type coincides with the parent's default child type or
\c putType was already called for the current item with a higher
value of \c priority.
\li \gui{putBetterType(self, type)} - Overrides the last recorded
\li \c{putBetterType(self, type)} - Overrides the last recorded
\c type.
\li \gui{putNumChild(self, numchild)} - Appends a field \c {numchild=''}
\li \c{putNumChild(self, numchild)} - Appends a field \c {numchild=''}
unless the \c numchild coincides with the parent's default child
numchild value.
\li \gui{putValue(self, value, encoding = None)} - Append a file \c {value=''},
\li \c{putValue(self, value, encoding = None)} - Append a file \c {value=''},
optionally followed by a field \c {valueencoding=''}. The \c value
needs to be convertible to a string entirely consisting of
alphanumerical values. The \c encoding parameter can be used to
......@@ -1072,16 +1072,16 @@
double quotes are added.
\endlist
\li \gui{putStringValue(self, value)} - Encodes a QString and calls
\li \c{putStringValue(self, value)} - Encodes a QString and calls
\c putValue with the correct \c encoding setting.
\li \gui{putByteArrayValue(self, value)} - Encodes a QByteArray and calls
\li \c{putByteArrayValue(self, value)} - Encodes a QByteArray and calls
\c putValue with the correct \c encoding setting.
\li \gui{isExpanded()} - Checks whether the current item
\li \c{isExpanded()} - Checks whether the current item
is expanded in the view.
\li \gui{putIntItem(self, name, value)} - Equivalent to:
\li \c{putIntItem(self, name, value)} - Equivalent to:
\code
with SubItem(self, name):
self.putValue(value)
......@@ -1090,7 +1090,7 @@
self.putNumChild(0)
\endcode
\li \gui{putBoolItem(self, name, value)} - Equivalent to:
\li \c{putBoolItem(self, name, value)} - Equivalent to:
\code
with SubItem(self, name):
self.putValue(value)
......@@ -1098,7 +1098,7 @@
self.putNumChild(0)
\endcode
\li \gui{putCallItem(self, name, value, func, *args)} -
\li \c{putCallItem(self, name, value, func, *args)} -
Uses GDB to call the function \c func on the value specified by
\a {value} and output the resulting item. Use \c{putCallItem}
only if there is no other way to access the data.
......@@ -1107,12 +1107,12 @@
and have the potential to change the state of the debugged
program.
\li \gui{putItem(self, value)} - The "master function", handling
\li \c{putItem(self, value)} - The "master function", handling
basic types, references, pointers and enums directly, iterates
over base classes and class members of compound types and calls
\c qdump__* functions whenever appropriate.
\li \gui{putSubItem(self, component, value)} - Equivalent to:
\li \c{putSubItem(self, component, value)} - Equivalent to:
\code
with SubItem(self, component):
self.putItem(value)
......@@ -1135,7 +1135,7 @@
use \c Children and \c SubItem \e{Context Managers} to create the nested
items.
The \c Children constructor \gui{__init__(self, dumper, numChild = 1,
The \c Children constructor \c{__init__(self, dumper, numChild = 1,
childType = None, childNumChild = None, maxNumChild = None, addrBase = None,
addrStep = None)} uses one mandatory argument and several
optional arguments. The mandatory argument refers to the current \c Dumper
......
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