diff options
| author | Leena Miettinen <[email protected]> | 2013-09-06 17:16:18 +0200 |
|---|---|---|
| committer | Leena Miettinen <[email protected]> | 2013-09-09 12:55:15 +0200 |
| commit | 2b573a6d8267e657e4b21f77f8bd838350a3edfb (patch) | |
| tree | b9516137132274183b4b71e119cf1bd1bdd928b7 /src/plugins/debugger/debuggerplugin.cpp | |
| parent | efbecf21dbdbc803c4c016fdb90803edec82cf19 (diff) | |
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 <[email protected]>
Diffstat (limited to 'src/plugins/debugger/debuggerplugin.cpp')
| -rw-r--r-- | src/plugins/debugger/debuggerplugin.cpp | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/plugins/debugger/debuggerplugin.cpp b/src/plugins/debugger/debuggerplugin.cpp index 5460c350333..b22901fc378 100644 --- a/src/plugins/debugger/debuggerplugin.cpp +++ b/src/plugins/debugger/debuggerplugin.cpp @@ -156,7 +156,7 @@ \brief The DebuggerEngine class is the base class of a debugger engine. - Note: the Debugger process itself and any helper processes like + \note The Debugger process itself and any helper processes like gdbserver are referred to as 'Engine', whereas the debugged process is referred to as 'Inferior'. @@ -327,9 +327,11 @@ sg1: } GdbEngine specific startup. All happens in EngineSetupRequested state: - Transitions marked by '---' are done in the individual adapters. + \list + \li Transitions marked by '---' are done in the individual adapters. - Transitions marked by '+-+' are done in the GdbEngine. + \li Transitions marked by '+-+' are done in the GdbEngine. + \endlist \code GdbEngine::setupEngine() |