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

4
src/plugins/cpptools/cppmodelmanager.cpp
View File

@@ -194,8 +194,8 @@ void CppModelManager::updateModifiedSourceFiles()
/*!
\class CppTools::CppModelManager
\brief The CppModelManager keeps track of one CppCodeModel instance
for each project and all related CppCodeModelPart instances.
\brief The CppModelManager class keeps track of one CppCodeModel instance
for each project and all the related CppCodeModelPart instances.
It also takes care of updating the code models when C++ files are
modified within Qt Creator.

3
src/plugins/cpptools/cpppointerdeclarationformatter.h
View File

@@ -46,7 +46,8 @@ typedef Utils::ChangeSet::Range Range;
/*!
\class CppTools::PointerDeclarationFormatter
\brief Rewrite pointer or reference declarations accordingly to an Overview.
\brief The PointerDeclarationFormatter class rewrites pointer or reference
declarations to an Overview.
The following constructs are supported:
\list