feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: use standard wording in \brief commands

Browse Source 
QDoc does some magic with the \class and \namespaces
and \brief commands, so the following wording must be used:
"The xxx class yyy ..."

Change-Id: Id231f30e8464898b776888d5423523de404aae34
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
This commit is contained in:
Leena Miettinen
2013-06-05 14:29:24 +02:00
parent 440725322a
commit 41411165ba
162 changed files with 486 additions and 291 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/plugins/debugger/debuggerplugin.cpp
View File

@@ -154,7 +154,7 @@
/*!
\class Debugger::DebuggerEngine
\brief Base class of a debugger engine.
\brief The DebuggerEngine class is the base class of a debugger engine.
Note: the Debugger process itself and any helper processes like
gdbserver are referred to as 'Engine', whereas the debugged process
@@ -322,7 +322,8 @@ sg1: }
/*!
\class Debugger::Internal::GdbEngine
\brief Implementation of Debugger::Engine driving a gdb executable.
\brief The GdbEngine class implements Debugger::Engine driving a GDB
executable.
GdbEngine specific startup. All happens in EngineSetupRequested state: