From 24ab4e7b01bcfbcac23aa6b49d756176c17e46d4 Mon Sep 17 00:00:00 2001 From: J-P Nurmi Date: Tue, 2 Jul 2013 17:25:49 +0200 Subject: [PATCH] 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 Reviewed-by: Frederik Gladhorn --- src/quick/items/qquicktextdocument.cpp | 18 ++++++++++++++++++ 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 e29e48c..4b4958e 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 7c22c01..7c87dfd 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 { -- 2.7.4