From 8ff63383e431385ec2dab4ad82e0081f1da6d461 Mon Sep 17 00:00:00 2001 From: Paul Wicking Date: Thu, 20 Aug 2020 15:10:59 +0200 Subject: [PATCH] Doc: Compile textdocument-end snippets MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Extend GUI snippet compilation with textdocument-end snippet. * Rename the snippet file and replace main() with wrapper(). * Dedent the snippet itself. * Update documentation that includes the snippet. Done-with: Nico Vertriest Task-number: QTBUG-81486 Change-Id: Id5e5b284587da1e7fdfd00baa9c899626832a113 Reviewed-by: Topi Reiniö --- src/gui/doc/snippets/snippets.pro | 4 ++-- .../textdocument-end/textdocumentend_snippet.pro | 5 +++++ .../textdocumentendsnippet.cpp | 14 +++++++------- src/gui/text/qtextdocument.cpp | 2 +- 4 files changed, 15 insertions(+), 10 deletions(-) create mode 100644 src/gui/doc/snippets/textdocument-end/textdocumentend_snippet.pro rename src/gui/doc/snippets/{ => textdocument-end}/textdocumentendsnippet.cpp (91%) diff --git a/src/gui/doc/snippets/snippets.pro b/src/gui/doc/snippets/snippets.pro index 6ad2d78387..230110ce5d 100644 --- a/src/gui/doc/snippets/snippets.pro +++ b/src/gui/doc/snippets/snippets.pro @@ -3,6 +3,6 @@ SUBDIRS = contains(QT_BUILD_PARTS, tests) { SUBDIRS += \ - qfontdatabase + qfontdatabase \ + textdocument-end } - diff --git a/src/gui/doc/snippets/textdocument-end/textdocumentend_snippet.pro b/src/gui/doc/snippets/textdocument-end/textdocumentend_snippet.pro new file mode 100644 index 0000000000..3c80ea77c2 --- /dev/null +++ b/src/gui/doc/snippets/textdocument-end/textdocumentend_snippet.pro @@ -0,0 +1,5 @@ +TEMPLATE = lib +TARGET = textdocumentend_snippets +QT += core gui widgets + +SOURCES = textdocumentendsnippet.cpp diff --git a/src/gui/doc/snippets/textdocumentendsnippet.cpp b/src/gui/doc/snippets/textdocument-end/textdocumentendsnippet.cpp similarity index 91% rename from src/gui/doc/snippets/textdocumentendsnippet.cpp rename to src/gui/doc/snippets/textdocument-end/textdocumentendsnippet.cpp index cb7abd5ca7..e56ad8d30b 100644 --- a/src/gui/doc/snippets/textdocumentendsnippet.cpp +++ b/src/gui/doc/snippets/textdocument-end/textdocumentendsnippet.cpp @@ -49,18 +49,18 @@ ****************************************************************************/ #include -#include +#include -int main(int argv, char **args) +namespace textdocumentendsnippet { +void wrapper() { QString contentString("One\nTwp\nThree"); - QTextDocument *doc = new QTextDocument(contentString); //! [0] - for (QTextBlock it = doc->begin(); it != doc->end(); it = it.next()) - cout << it.text().toStdString() << Qt::endl; +for (QTextBlock it = doc->begin(); it != doc->end(); it = it.next()) + std::cout << it.text().toStdString() << "\n"; //! [0] - return 0; -} +} // wrapper +} //textdocumentendsnippet diff --git a/src/gui/text/qtextdocument.cpp b/src/gui/text/qtextdocument.cpp index a4ecbd157f..3cee66095b 100644 --- a/src/gui/text/qtextdocument.cpp +++ b/src/gui/text/qtextdocument.cpp @@ -1642,7 +1642,7 @@ QTextBlock QTextDocument::begin() const This function returns a block to test for the end of the document while iterating over it. - \snippet textdocumentendsnippet.cpp 0 + \snippet textdocument-end/textdocumentendsnippet.cpp 0 The block returned is invalid and represents the block after the last block in the document. You can use lastBlock() to retrieve the