summaryrefslogtreecommitdiffstats
path: root/src/gui/text/qsyntaxhighlighter.cpp
diff options
context:
space:
mode:
authorEskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@nokia.com>2012-08-24 12:47:21 +0200
committerQt by Nokia <qt-info@nokia.com>2012-08-25 19:04:56 +0200
commit1349299f458f41fdc9e7ac4a0592eaa358d2b033 (patch)
tree9104a3d7a9e35f06c6b7845837df85bc027ce278 /src/gui/text/qsyntaxhighlighter.cpp
parent72a7c43e90917afd57564b881499322e92bbe78d (diff)
doc: Fix several text-related qdoc warnings
Also adds a new snippet which is just copy-pasted from the old documentation, because the snippet-file previously referenced seems to have disappeared. Change-Id: I0180715544321e076acda769cbdcbf19d50a971b Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
Diffstat (limited to 'src/gui/text/qsyntaxhighlighter.cpp')
-rw-r--r--src/gui/text/qsyntaxhighlighter.cpp11
1 files changed, 5 insertions, 6 deletions
diff --git a/src/gui/text/qsyntaxhighlighter.cpp b/src/gui/text/qsyntaxhighlighter.cpp
index fb02ad6686..608a1ceca1 100644
--- a/src/gui/text/qsyntaxhighlighter.cpp
+++ b/src/gui/text/qsyntaxhighlighter.cpp
@@ -241,17 +241,16 @@ void QSyntaxHighlighterPrivate::reformatBlock(const QTextBlock &block)
\ingroup richtext-processing
The QSyntaxHighlighter class is a base class for implementing
- QTextEdit syntax highlighters. A syntax highligher automatically
- highlights parts of the text in a QTextEdit, or more generally in
- a QTextDocument. Syntax highlighters are often used when the user
- is entering text in a specific format (for example source code)
+ QTextDocument syntax highlighters. A syntax highligher automatically
+ highlights parts of the text in a QTextDocument. Syntax highlighters are
+ often used when the user is entering text in a specific format (for example source code)
and help the user to read the text and identify syntax errors.
To provide your own syntax highlighting, you must subclass
QSyntaxHighlighter and reimplement highlightBlock().
When you create an instance of your QSyntaxHighlighter subclass,
- pass it the QTextEdit or QTextDocument that you want the syntax
+ pass it the QTextDocument that you want the syntax
highlighting to be applied to. For example:
\snippet code/src_gui_text_qsyntaxhighlighter.cpp 0
@@ -306,7 +305,7 @@ void QSyntaxHighlighterPrivate::reformatBlock(const QTextBlock &block)
parsing the paragraph's text. For an example, see the
setCurrentBlockUserData() documentation.
- \sa QTextEdit, {Syntax Highlighter Example}
+ \sa QTextDocument, {Syntax Highlighter Example}
*/
/*!