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

3
src/plugins/vcsbase/baseannotationhighlighter.cpp
View File

@@ -39,7 +39,8 @@ typedef QMap<QString, QTextCharFormat> ChangeNumberFormatMap;
/*!
\class VcsBase::BaseAnnotationHighlighter
\brief Base for a highlighter for annotation lines of the form 'changenumber:XXXX'.
\brief The BaseAnnotationHighlighter class is the base class for a
highlighter for annotation lines of the form 'changenumber:XXXX'.
The change numbers are assigned a color gradient. Example:
\code