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

@@ -460,7 +460,7 @@ QDebug operator<<(QDebug s, const WinException &e)
/*!
\fn DisassemblerLines parseCdbDisassembler(const QList<QByteArray> &a)
\brief Parse CDB disassembler output into DisassemblerLines (with helpers)
Parses CDB disassembler output into DisassemblerLines (with helpers).
Expected options (prepend source file line):
\code