Doc: Add index and module files for Qt PDF module and fix header path

Change-Id: I6c8dbc3c8d5c8638d7098ab1d4f2999a4c2e6042
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
Reviewed-by: Michal Klocek <michal.klocek@qt.io>

4 files changed, 150 insertions, 1 deletions

diff --git a/src/pdf/doc/qtpdf.qdocconf b/src/pdf/doc/qtpdf.qdocconf
index 0237cd310..3c5d342d4 100644
--- a/src/pdf/doc/qtpdf.qdocconf
+++ b/src/pdf/doc/qtpdf.qdocconf
@@ -27,7 +27,7 @@ depends += qtcore \
            qtdoc \
            qmake
 
-headerdirs  += ..
+headerdirs  += ../api
 
 sourcedirs  += ..
 
diff --git a/src/pdf/doc/snippets/qtpdf_build_snippet.qdoc b/src/pdf/doc/snippets/qtpdf_build_snippet.qdoc
new file mode 100644
index 000000000..25593b1ee
--- /dev/null
+++ b/src/pdf/doc/snippets/qtpdf_build_snippet.qdoc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+//! [0]
+QT += pdf
+//! [0]
+
+
+//! [1]
+#include <QtPdf>
+//! [1]
diff --git a/src/pdf/doc/src/qtpdf-index.qdoc b/src/pdf/doc/src/qtpdf-index.qdoc
new file mode 100644
index 000000000..e55e16f8e
--- /dev/null
+++ b/src/pdf/doc/src/qtpdf-index.qdoc
@@ -0,0 +1,64 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \page qtpdf-index.html
+    \title Qt PDF
+
+    \brief Renders pages from PDF documents.
+
+    The Qt PDF module contains classes and functions for rendering
+    PDF documents. The \l QPdfDocument class loads a PDF document
+    and renders pages from it according to the options provided by
+    the \l QPdfDocumentRenderOptions class. The \l QPdfPageRenderer
+    class manages a queue that collects all render requests. The
+    \l QPdfPageNavigation class handles the navigation through a
+    PDF document.
+
+    \section1 Getting Started
+
+    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
+
+    \section1 Articles and Guides
+
+    \list
+        \li \l{Qt WebEngine Overview}
+    \endlist
+
+    \section1 API Reference
+
+    \list
+        \li \l{Qt PDF C++ Classes}
+    \endlist
+*/
diff --git a/src/pdf/doc/src/qtpdf-module.qdoc b/src/pdf/doc/src/qtpdf-module.qdoc
new file mode 100644
index 000000000..4170deb38
--- /dev/null
+++ b/src/pdf/doc/src/qtpdf-module.qdoc
@@ -0,0 +1,50 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+
+/*!
+    \module QtPdf
+    \title Qt PDF C++ Classes
+    \brief Renders pages from PDF documents.
+    \since 5.14
+    \ingroup qtwebengine-modules
+    \ingroup modules
+
+    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:
+
+    \snippet qtpdf_build_snippet.qdoc 0
+    \endif
+*/