aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/vcsbase/baseannotationhighlighter.cpp
diff options
context:
space:
mode:
authorFriedemann Kleint <[email protected]>2011-03-28 14:19:17 +0200
committerFriedemann Kleint <[email protected]>2011-03-28 14:19:17 +0200
commit58111b2df2549bb143325081845c80d50ba46e5c (patch)
treef3c8b6916d2cd30c2d6c4598dee26b2d6b8d867a /src/plugins/vcsbase/baseannotationhighlighter.cpp
parent34a96d8808a1120fb879d22ef1b052ce30996454 (diff)
API Documentation: Add VCSBase.
Diffstat (limited to 'src/plugins/vcsbase/baseannotationhighlighter.cpp')
-rw-r--r--src/plugins/vcsbase/baseannotationhighlighter.cpp13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/plugins/vcsbase/baseannotationhighlighter.cpp b/src/plugins/vcsbase/baseannotationhighlighter.cpp
index 4830375a993..0981e86cc12 100644
--- a/src/plugins/vcsbase/baseannotationhighlighter.cpp
+++ b/src/plugins/vcsbase/baseannotationhighlighter.cpp
@@ -43,6 +43,19 @@
typedef QMap<QString, QTextCharFormat> ChangeNumberFormatMap;
+/*!
+ \class VCSBase::BaseAnnotationHighlighter
+
+ \brief Base for a highlighter for annotation lines of the form 'changenumber:XXXX'.
+
+ The change numbers are assigned a color gradient. Example:
+ \code
+ 112: text1 <color 1>
+ 113: text2 <color 2>
+ 112: text3 <color 1>
+ \endcode
+*/
+
namespace VCSBase {
struct BaseAnnotationHighlighterPrivate {