diff options
| author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-06-05 14:29:24 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-06-20 11:22:47 +0200 |
| commit | 41411165bac561d3cd93a793c6ae76dcb2937e12 (patch) | |
| tree | cc9e5e516899407448ad8eadd207909ee3115493 /src/libs/cplusplus/CppDocument.cpp | |
| parent | 440725322abf0189c0cb28baddebe76bc26c5f05 (diff) | |
| download | qt-creator-41411165bac561d3cd93a793c6ae76dcb2937e12.tar.gz | |
Doc: use standard wording in \brief commands
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>
Diffstat (limited to 'src/libs/cplusplus/CppDocument.cpp')
| -rw-r--r-- | src/libs/cplusplus/CppDocument.cpp | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/libs/cplusplus/CppDocument.cpp b/src/libs/cplusplus/CppDocument.cpp index 7df0d2d2e5..9b92eda5d8 100644 --- a/src/libs/cplusplus/CppDocument.cpp +++ b/src/libs/cplusplus/CppDocument.cpp @@ -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 |