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

@@ -2412,9 +2412,9 @@ void GdbEngine::handleExecuteReturn(const GdbResponse &response)
}
/*!
\brief Discard the results of all pending watch-updating commands.
Discards the results of all pending watch-updating commands.
This method is called at the beginning of all step/next/finish etc.
This method is called at the beginning of all step, next, finish, and so on,
debugger functions.
If non-watch-updating commands with call-backs are still in the pipe,
it will complain.