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

@@ -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()