summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2014-11-11 13:10:52 +0100
committerTopi Reiniƶ <topi.reinio@digia.com>2014-11-11 15:41:24 +0100
commit4bd7c4e44ac1c95603f6924670d7a7bf7bca83fb (patch)
treea67a7d8aee750fa24347070c1337192e1fa7ceeb
parent9c84c7004078f261a4cd58d7a56b7a08432737e8 (diff)
Fix various documentation issues
- Replace multiple include statements with a single, Qt module include - Remove url variable (taken from the global config) - Remove indexes variable (using 'depends' is sufficient) - Remove unused subproject - Fix selector for QML types - Fix example path to have working manifest XML - Rename index.html to qtwebview-index.html (to avoid collision with the main Qt doc index page) - Fix section titles and add a 'QML Types' section for the QML module page. Change-Id: Ie30582d8db83bfbdee613efec66013bb73d1a9b1 Reviewed-by: Christian Stromme <christian.stromme@digia.com>
-rw-r--r--src/webview/doc/qtwebview.qdocconf19
-rw-r--r--src/webview/doc/src/qtwebview-overview.qdoc4
-rw-r--r--src/webview/doc/src/qtwebview-qmltypes.qdoc3
3 files changed, 9 insertions, 17 deletions
diff --git a/src/webview/doc/qtwebview.qdocconf b/src/webview/doc/qtwebview.qdocconf
index c0e9f08..93855f1 100644
--- a/src/webview/doc/qtwebview.qdocconf
+++ b/src/webview/doc/qtwebview.qdocconf
@@ -1,12 +1,7 @@
-include($QT_INSTALL_DOCS/global/macros.qdocconf)
-include($QT_INSTALL_DOCS/global/qt-cpp-defines.qdocconf)
-include($QT_INSTALL_DOCS/global/compat.qdocconf)
-include($QT_INSTALL_DOCS/global/fileextensions.qdocconf)
-include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf)
+include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
project = QtWebView
description = Qt WebView Reference Documentation
-url = http://qt-project.org/doc/qt-$QT_VER
version = $QT_VERSION
qhp.projects = QtWebView
@@ -20,23 +15,19 @@ qhp.QtWebView.filterAttributes = qtwebview 1.0 qtrefdoc
qhp.QtWebView.customFilters.Qt.name = QtWebView 1.0
qhp.QtWebView.customFilters.Qt.filterAttributes = qtwebview 1.0
-qhp.QtWebView.subprojects = qmltypes classes examples
+qhp.QtWebView.subprojects = qmltypes examples
qhp.QtWebView.subprojects.qmltypes.title = QML Types
qhp.QtWebView.subprojects.qmltypes.indexTitle = Qt WebView QML Types
-qhp.QtWebView.subprojects.qmltypes.selectors = fake:qmlclass
+qhp.QtWebView.subprojects.qmltypes.selectors = qmlclass
qhp.QtWebView.subprojects.qmltypes.sortPages = true
qhp.QtWebView.subprojects.examples.title = Examples
qhp.QtWebView.subprojects.examples.indexTitle = Qt WebView Examples
qhp.QtWebView.subprojects.examples.selectors = fake:example
-
-indexes += $QT_INSTALL_DOCS/qtqml/qtqml.index \
- $QT_INSTALL_DOCS/qtquick/qtquick.index \
- $QT_INSTALL_DOCS/qtdoc/qtdoc.index \
- $QT_INSTALL_DOCS/qtquickcontrols/qtquickcontrols.index
+qhp.QtWebView.subprojects.examples.sortPages = true
headerdirs += ../ ../../imports/ ../
sourcedirs += ../ ../../imports/ ../
-exampledirs += ../../../examples
+exampledirs += ../../../examples/webview
imagedirs += images
examplesinstallpath = webview
diff --git a/src/webview/doc/src/qtwebview-overview.qdoc b/src/webview/doc/src/qtwebview-overview.qdoc
index 54a3751..499fe41 100644
--- a/src/webview/doc/src/qtwebview-overview.qdoc
+++ b/src/webview/doc/src/qtwebview-overview.qdoc
@@ -26,7 +26,7 @@
****************************************************************************/
/*!
- \page index.html
+ \page qtwebview-index.html
\title Qt WebView
\brief A light-weight web view.
@@ -39,7 +39,7 @@
The WebView is currently supported on the following platforms: Android and iOS.
- \section1 QML types
+ \section1 QML Types
The module provides a single QML component for displaying web content in
the application: \l{WebView}.
diff --git a/src/webview/doc/src/qtwebview-qmltypes.qdoc b/src/webview/doc/src/qtwebview-qmltypes.qdoc
index 8c7990f..02af25b 100644
--- a/src/webview/doc/src/qtwebview-qmltypes.qdoc
+++ b/src/webview/doc/src/qtwebview-qmltypes.qdoc
@@ -37,8 +37,9 @@
The QML type can be imported into your application using the following
import statement:
- \code
+ \badcode
import QtWebView 1.0
\endcode
+ \section1 QML Types
*/