Fix missing QQuickTextDocument docs
authorJ-P Nurmi <jpnurmi@digia.com>
Tue, 2 Jul 2013 15:25:49 +0000 (17:25 +0200)
committerThe Qt Project <gerrit-noreply@qt-project.org>
Tue, 2 Jul 2013 16:50:52 +0000 (18:50 +0200)
It didn't appear in the docs at all. Moving the documentation to .cpp
fixes the problem.

Change-Id: Id9741bc6dab20ba976952143160d3551787fae40
Reviewed-by: Liang Qi <liang.qi@digia.com>
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
src/quick/items/qquicktextdocument.cpp
src/quick/items/qquicktextdocument.h

index e29e48c..4b4958e 100644 (file)
 
 QT_BEGIN_NAMESPACE
 
+/*!
+    \class QQuickTextDocument
+    \since 5.1
+    \brief The QQuickTextDocument class provides access to the QTextDocument of QQuickTextEdit
+    \inmodule QtQuick
+
+    This class provides access to the QTextDocument of QQuickTextEdit elements.
+    This is provided to allow usage of the \l{Rich Text Processing} functionalities of Qt.
+    You are not allowed to modify the document, but it can be used to output content, for example with \l{QTextDocumentWriter}),
+    or provide additional formatting, for example with \l{QSyntaxHighlighter}.
+
+    The class has to be used from C++ directly, using the property of the \l TextEdit.
+
+    Warning: The QTextDocument provided is used internally by \l {Qt Quick} elements to provide text manipulation primitives.
+    You are not allowed to perform any modification of the internal state of the QTextDocument. If you do, the element
+    in question may stop functioning or crash.
+*/
+
 class QQuickTextDocumentPrivate : public QObjectPrivate
 {
 public:
index 7c22c01..7c87dfd 100644 (file)
 
 QT_BEGIN_NAMESPACE
 
-/*!
-    \class QQuickTextDocument
-    \since 5.1
-    \brief The QQuickTextDocument class provides access to the QTextDocument of QQuickTextEdit
-    \inmodule QtQuick
-
-    This class provides access to the QTextDocument of QQuickTextEdit elements.
-    This is provided to allow usage of the \l{Rich Text Processing} functionalities of Qt.
-    You are not allowed to modify the document, but it can be used to output content, for example with \l{QTextDocumentWriter}),
-    or provide additional formatting, for example with \l{QSyntaxHighlighter}.
-
-    The class has to be used from C++ directly, using the property of the \l TextEdit.
-
-    Warning: The QTextDocument provided is used internally by \l {Qt Quick} elements to provide text manipulation primitives.
-    You are not allowed to perform any modification of the internal state of the QTextDocument. If you do, the element
-    in question may stop functioning or crash.
-*/
-
 class QQuickTextDocumentPrivate;
 class Q_QUICK_EXPORT QQuickTextDocument : public QObject
 {