summaryrefslogtreecommitdiff
path: root/src/plugins/texteditor/basetextdocument.cpp
diff options
context:
space:
mode:
authorEike Ziller <eike.ziller@digia.com>2014-01-21 14:22:33 +0100
committerEike Ziller <eike.ziller@digia.com>2014-01-23 09:21:15 +0100
commit5deb0f367ee5bedc4cbdc12a8ee766aff3c87957 (patch)
tree53f447b4d5eecf504297d0f183f90b7c4a8bb993 /src/plugins/texteditor/basetextdocument.cpp
parent2678662fb492d1cf5340894a6f7112fbd2e2c6a8 (diff)
downloadqt-creator-5deb0f367ee5bedc4cbdc12a8ee766aff3c87957.tar.gz
Editors: Add at least some short documentation.
Change-Id: I7fc7946405d3cbb1af0cf29a9d328d857eb8304a Reviewed-by: Eike Ziller <eike.ziller@digia.com>
Diffstat (limited to 'src/plugins/texteditor/basetextdocument.cpp')
-rw-r--r--src/plugins/texteditor/basetextdocument.cpp8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/plugins/texteditor/basetextdocument.cpp b/src/plugins/texteditor/basetextdocument.cpp
index 5fb119e81e..c04e48488c 100644
--- a/src/plugins/texteditor/basetextdocument.cpp
+++ b/src/plugins/texteditor/basetextdocument.cpp
@@ -54,6 +54,14 @@
using namespace Core;
+/*!
+ \class TextEditor::BaseTextDocument
+ \brief The BaseTextDocument class is the base class for QTextDocument based documents.
+
+ Subclasses of BaseTextEditor can either use BaseTextDocument as is (and this is the default),
+ or created subclasses of BaseTextDocument if they have special requirements.
+*/
+
namespace TextEditor {
class BaseTextDocumentPrivate
{