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

6
src/libs/cplusplus/CppDocument.cpp
View File

@@ -381,13 +381,15 @@ void Document::addUndefinedMacroUse(const QByteArray &name, unsigned offset)
/*!
\class Document::MacroUse
\brief Represents the usage of a macro in a \l {Document}.
\brief The MacroUse class represents the usage of a macro in a
\l {Document}.
\sa Document::UndefinedMacroUse
*/
/*!
\class Document::UndefinedMacroUse
\brief Represents a macro that was looked up, but not found.
\brief The UndefinedMacroUse class represents a macro that was looked for,
but not found.
Holds data about the reference to a macro in an \tt{#ifdef} or \tt{#ifndef}
or argument to the \tt{defined} operator inside an \tt{#if} or \tt{#elif} that does