diff options
Diffstat (limited to 'src/pdf/doc')
-rw-r--r-- | src/pdf/doc/about_credits.tmpl | 1 | ||||
-rw-r--r-- | src/pdf/doc/about_credits_entry.tmpl | 13 | ||||
-rw-r--r-- | src/pdf/doc/images/pdfviewer.png | bin | 0 -> 264348 bytes | |||
-rw-r--r-- | src/pdf/doc/images/singlepageviewer.webp | bin | 0 -> 57680 bytes | |||
-rw-r--r-- | src/pdf/doc/qtpdf.qdocconf | 8 | ||||
-rw-r--r-- | src/pdf/doc/snippets/multipageview.qml | 3 | ||||
-rw-r--r-- | src/pdf/doc/snippets/pdfpageview.qml | 12 | ||||
-rw-r--r-- | src/pdf/doc/snippets/qtpdf_build_snippet.qdoc | 5 | ||||
-rw-r--r-- | src/pdf/doc/src/qtpdf-examples.qdoc | 1 | ||||
-rw-r--r-- | src/pdf/doc/src/qtpdf-index.qdoc | 20 | ||||
-rw-r--r-- | src/pdf/doc/src/qtpdf-licensing.qdoc | 18 | ||||
-rw-r--r-- | src/pdf/doc/src/qtpdf-module.qdoc | 5 | ||||
-rw-r--r-- | src/pdf/doc/src/qtpdf-platformnotes.qdoc | 11 |
13 files changed, 78 insertions, 19 deletions
diff --git a/src/pdf/doc/about_credits.tmpl b/src/pdf/doc/about_credits.tmpl new file mode 100644 index 000000000..57fae9e78 --- /dev/null +++ b/src/pdf/doc/about_credits.tmpl @@ -0,0 +1 @@ +{{entries}} diff --git a/src/pdf/doc/about_credits_entry.tmpl b/src/pdf/doc/about_credits_entry.tmpl new file mode 100644 index 000000000..294198709 --- /dev/null +++ b/src/pdf/doc/about_credits_entry.tmpl @@ -0,0 +1,13 @@ +/*! +\page qtpdf-3rdparty-{{name-sanitized}}.html +\attribution +\ingroup qtpdf-licensing +\brief {{license-type}} +\title {{name}} + +\l{{{url}}}{Project Homepage} + +\badcode +{{license}} +\endcode +*/ diff --git a/src/pdf/doc/images/pdfviewer.png b/src/pdf/doc/images/pdfviewer.png Binary files differnew file mode 100644 index 000000000..ac8a31ac0 --- /dev/null +++ b/src/pdf/doc/images/pdfviewer.png diff --git a/src/pdf/doc/images/singlepageviewer.webp b/src/pdf/doc/images/singlepageviewer.webp Binary files differnew file mode 100644 index 000000000..e429cb818 --- /dev/null +++ b/src/pdf/doc/images/singlepageviewer.webp diff --git a/src/pdf/doc/qtpdf.qdocconf b/src/pdf/doc/qtpdf.qdocconf index 6be1b46e0..d0340fe83 100644 --- a/src/pdf/doc/qtpdf.qdocconf +++ b/src/pdf/doc/qtpdf.qdocconf @@ -1,4 +1,5 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) +include($QT_INSTALL_DOCS/config/exampleurl-qtwebengine.qdocconf) project = QtPdf description = Qt Pdf Reference Documentation @@ -29,6 +30,8 @@ qhp.QtPdf.subprojects.examples.indexTitle = Qt PDF Examples qhp.QtPdf.subprojects.examples.selectors = doc:example qhp.QtPdf.subprojects.examples.sortPages = true +manifestmeta.highlighted.names += "QtPdf/PDF Multipage Viewer Example" + depends += qtcore \ qtwidgets \ qtgui \ @@ -37,7 +40,8 @@ depends += qtcore \ qtdesigner \ qtquick \ qtquickcontrols \ - qtcmake + qtcmake \ + qtsvg headerdirs += ../ \ ../../pdfwidgets @@ -59,5 +63,5 @@ navigation.landingpage = "Qt PDF" navigation.cppclassespage = "Qt PDF C++ Classes" navigation.qmltypespage = "Qt Quick PDF QML Types" -# Fail the documentation build if there are more warnings than the limit +# Enforce zero documentation warnings warninglimit = 0 diff --git a/src/pdf/doc/snippets/multipageview.qml b/src/pdf/doc/snippets/multipageview.qml index ee695c03a..113444165 100644 --- a/src/pdf/doc/snippets/multipageview.qml +++ b/src/pdf/doc/snippets/multipageview.qml @@ -1,3 +1,6 @@ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause + //! [0] import QtQuick import QtQuick.Pdf diff --git a/src/pdf/doc/snippets/pdfpageview.qml b/src/pdf/doc/snippets/pdfpageview.qml new file mode 100644 index 000000000..5e233961a --- /dev/null +++ b/src/pdf/doc/snippets/pdfpageview.qml @@ -0,0 +1,12 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause + +//! [0] +import QtQuick +import QtQuick.Pdf + +PdfPageView { + document: PdfDocument { source: "my.pdf" } +} +//! [0] + diff --git a/src/pdf/doc/snippets/qtpdf_build_snippet.qdoc b/src/pdf/doc/snippets/qtpdf_build_snippet.qdoc index 4be08b5a7..7d30ccdfd 100644 --- a/src/pdf/doc/snippets/qtpdf_build_snippet.qdoc +++ b/src/pdf/doc/snippets/qtpdf_build_snippet.qdoc @@ -4,8 +4,3 @@ //! [0] QT += pdf //! [0] - - -//! [1] -#include <QtPdf> -//! [1] diff --git a/src/pdf/doc/src/qtpdf-examples.qdoc b/src/pdf/doc/src/qtpdf-examples.qdoc index 0ebad3c82..02dc23dc2 100644 --- a/src/pdf/doc/src/qtpdf-examples.qdoc +++ b/src/pdf/doc/src/qtpdf-examples.qdoc @@ -3,7 +3,6 @@ /*! \group qtpdf-examples - \ingroup all-examples \title Qt PDF Examples \brief Using the classes and types in the Qt PDF module. diff --git a/src/pdf/doc/src/qtpdf-index.qdoc b/src/pdf/doc/src/qtpdf-index.qdoc index 1e37565f5..b72619fbf 100644 --- a/src/pdf/doc/src/qtpdf-index.qdoc +++ b/src/pdf/doc/src/qtpdf-index.qdoc @@ -17,7 +17,7 @@ and holds the search results. The QPdfBookmarkModel class holds the table of contents, if present. The QPdfLinkModel holds information about hyperlinks on a page. The \l QPdfView widget is a complete - PDF viewer, and the \l {PDF Viewer Example} shows how to use it. + PDF viewer, and the \l {PDF Viewer Widget Example} shows how to use it. For Qt Quick applications, three kinds of full-featured viewer components are provided. \l PdfMultiPageView should be your @@ -48,11 +48,6 @@ \section2 Building with qmake - To include the definitions of the module's classes, use the - following directive: - - \snippet qtpdf_build_snippet.qdoc 1 - To link against the module, add this line to your qmake project file: \snippet qtpdf_build_snippet.qdoc 0 @@ -69,4 +64,17 @@ \li \l{Qt PDF C++ Classes} \li \l{Qt Quick PDF QML Types} \endlist + + \section1 Articles and Guides + \list + \li {Qt PDF Platform Notes} {Platform Notes} + \endlist + + \section1 Licenses and Attributions + + Qt PDF is available under commercial licenses from \l{The Qt Company}. + In addition, it is available under the + \l{GNU Lesser General Public License, version 3}, or + the \l{GNU General Public License, version 2}. + See \l{Qt PDF Licensing} for further details about this module. */ diff --git a/src/pdf/doc/src/qtpdf-licensing.qdoc b/src/pdf/doc/src/qtpdf-licensing.qdoc new file mode 100644 index 000000000..190ee8331 --- /dev/null +++ b/src/pdf/doc/src/qtpdf-licensing.qdoc @@ -0,0 +1,18 @@ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \group qtpdf-licensing + \title Qt PDF Licensing + + Qt PDF is available under commercial licenses from \l{The Qt Company}. + In addition, it is available under the + \l{GNU Lesser General Public License, version 3}, or + the \l{GNU General Public License, version 2}. + See \l{Qt Licensing} for further details. + + The module includes a snapshot of PDFium. As such, users need to respect + the licenses of PDFium and third-party code included in it. + + Third party licenses included in the sources are: +*/ diff --git a/src/pdf/doc/src/qtpdf-module.qdoc b/src/pdf/doc/src/qtpdf-module.qdoc index 6fe1bbcac..e2ca8e4ce 100644 --- a/src/pdf/doc/src/qtpdf-module.qdoc +++ b/src/pdf/doc/src/qtpdf-module.qdoc @@ -13,11 +13,6 @@ The Qt PDF module contains classes and functions for rendering PDF documents. - To include the definitions of the module's classes, use the - following directive: - - \snippet qtpdf_build_snippet.qdoc 1 - \if !defined(qtforpython) To link against the module, add this line to your qmake project file: diff --git a/src/pdf/doc/src/qtpdf-platformnotes.qdoc b/src/pdf/doc/src/qtpdf-platformnotes.qdoc new file mode 100644 index 000000000..f50be120d --- /dev/null +++ b/src/pdf/doc/src/qtpdf-platformnotes.qdoc @@ -0,0 +1,11 @@ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \page qtpdf-platformnotes.html + \title Qt PDF Platform Notes + + Building Qt PDF for Android is currently + \l{https://bugreports.qt.io/browse/QTBUG-83459} {not supported} on Windows host platforms. +*/ + |