diff options
| author | J-P Nurmi <jpnurmi@digia.com> | 2013-07-02 17:25:49 +0200 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-07-02 18:50:52 +0200 |
| commit | 24ab4e7b01bcfbcac23aa6b49d756176c17e46d4 (patch) | |
| tree | b1d6dc33ac3a2b6eafa61347ead2eec128438e14 | |
| parent | ee88f23f430aa266c1cc19e823b1815133df15aa (diff) | |
Fix missing QQuickTextDocument docs
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>
| -rw-r--r-- | src/quick/items/qquicktextdocument.cpp | 18 | ||||
| -rw-r--r-- | src/quick/items/qquicktextdocument.h | 18 |
2 files changed, 18 insertions, 18 deletions
diff --git a/src/quick/items/qquicktextdocument.cpp b/src/quick/items/qquicktextdocument.cpp index e29e48c5d0..4b4958e122 100644 --- a/src/quick/items/qquicktextdocument.cpp +++ b/src/quick/items/qquicktextdocument.cpp @@ -47,6 +47,24 @@ 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: diff --git a/src/quick/items/qquicktextdocument.h b/src/quick/items/qquicktextdocument.h index 7c22c01d5a..7c87dfd1e7 100644 --- a/src/quick/items/qquicktextdocument.h +++ b/src/quick/items/qquicktextdocument.h @@ -47,24 +47,6 @@ 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 { |