Doc: edit debugger API docs

Remove \brief commands from function descriptions.
Use QDoc commands for notes and lists.
Write GDB in all caps.
Fix punctuation and style and grammar issues.

Change-Id: I7f5bf0f53ad643eb4e2981c0d4e39c453dff5558
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
This commit is contained in:
Leena Miettinen
2013-09-06 17:16:18 +02:00
parent efbecf21db
commit 2b573a6d82
7 changed files with 15 additions and 13 deletions

View File

@@ -568,7 +568,7 @@ QDebug operator<<(QDebug d, const DebuggerToolTipContext &c)
(defaultModel) and displays that.
It is associated with file name and position with functionality to
acquire and release the engine: When the debugger stops at a file, all
acquire and release the engine. When the debugger stops at a file, all
matching tooltips acquire the engine, that is, display the engine data.
When continuing or switching away from the frame, the tooltips release the
engine, that is, store the data internally and keep displaying them
@@ -1086,11 +1086,11 @@ QString DebuggerToolTipWidget::clipboardContents() const
listens on editor scroll and main window move
events and takes care of repositioning the tooltips.
Listens to editor change and mode change. In debug mode, if there tooltips
for the current editor (by file name), position and show them.
Listens to editor change and mode change. In debug mode, if there are tooltips
for the current editor (by file name), positions and shows them.
In addition, listens on state change and stack frame completed signals
of the engine. If a stack frame is completed, have all matching tooltips
of the engine. If a stack frame is completed, has all matching tooltips
(by file name and function) acquire the engine, others release.
*/