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/plugins/vcsbase/baseannotationhighlighter.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/plugins/vcsbase/baseannotationhighlighter.cpp')
| -rw-r--r-- | src/plugins/vcsbase/baseannotationhighlighter.cpp | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/plugins/vcsbase/baseannotationhighlighter.cpp b/src/plugins/vcsbase/baseannotationhighlighter.cpp index 613c2a7b90..3a04647103 100644 --- a/src/plugins/vcsbase/baseannotationhighlighter.cpp +++ b/src/plugins/vcsbase/baseannotationhighlighter.cpp @@ -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 |