aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCaroline Chao <caroline.chao@digia.com>2014-02-03 14:12:07 +0100
committerMitch Curtis <mitch.curtis@digia.com>2014-02-04 11:00:53 +0200
commit074aac8d8333e3bbc6415a4a240fbeef2770b5da (patch)
treeaed3e539acf0f7675abbcf4bedf31e2a38b6ec92
parentda60df719c4794c21d03114c57d81e7748322c0b (diff)
Fixes in qdocconfv1.0.0-tp1
- Don't make the Virtual Keyboard doc part of Qt's - Update path to examples - Add navigation pages - Give the project its own version - Add "standard" doc include - Make doc for DeclarativeInputContext internal - Move code snippets folder Change-Id: Ib46e27bd6dd70225583d75cf5567d65a11cfaa2e Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com> Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
-rw-r--r--src/virtualkeyboard/declarativeinputcontext.cpp1
-rw-r--r--src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf28
-rw-r--r--src/virtualkeyboard/doc/snippets/CustomInputMethod.qml (renamed from src/virtualkeyboard/doc/src/snippets/CustomInputMethod.qml)0
-rw-r--r--src/virtualkeyboard/doc/src/qtvirtualkeyboard-examples.qdoc2
-rw-r--r--src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc2
5 files changed, 17 insertions, 16 deletions
diff --git a/src/virtualkeyboard/declarativeinputcontext.cpp b/src/virtualkeyboard/declarativeinputcontext.cpp
index c57d8f6e..6974cf24 100644
--- a/src/virtualkeyboard/declarativeinputcontext.cpp
+++ b/src/virtualkeyboard/declarativeinputcontext.cpp
@@ -74,6 +74,7 @@ public:
\inmodule InputFramework
\ingroup qtvirtualkeyboard-qml
\brief Provides access to an input context.
+ \internal
*/
/*!
diff --git a/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf b/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf
index eee4d3f3..957f2e3f 100644
--- a/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf
+++ b/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf
@@ -1,9 +1,13 @@
-include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
+include($QT_INSTALL_DOCS/global/macros.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-cpp-defines.qdocconf)
project = QtVirtualKeyboard
description = Qt Virtual Keyboard
-version = $QT_VERSION
+version = 1.0
headerdirs += ..
sourcedirs += ..
@@ -11,28 +15,20 @@ sourcedirs += ..
# Specify the install path under QT_INSTALL_EXAMPLES
# Examples will be installed under quick/enterprise/virtualkeyboard -
# 'enterprise/virtualkeyboard' subdirectory is given as part of \example commands
-exampledirs += ../../../examples/quick/enterprise/virtualkeyboard \
- src/snippets
-examplesinstallpath = quick/enterprise/virtualkeyboard
+exampledirs += ../../../examples/quick \
+ snippets
+examplesinstallpath = quick
imagedirs += images
depends += qtcore qtgui qtquick
-# spurious = "Can't link to 'All Modules'"
-
-sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
-headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
-examples.fileextensions = "*.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml"
-examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng"
-
qhp.projects = QtVirtualKeyboard
qhp.QtVirtualKeyboard.file = qtvirtualkeyboard.qhp
qhp.QtVirtualKeyboard.namespace = com.digia.qtvirtualkeyboard.100
qhp.QtVirtualKeyboard.virtualFolder = qtvirtualkeyboard
-qhp.QtVirtualKeyboard.indexTitle = Qt Virtual Keyboard Reference
+qhp.QtVirtualKeyboard.indexTitle = Qt Virtual Keyboard
qhp.QtVirtualKeyboard.indexRoot =
-qhp.QtVirtualKeyboard.extraFiles = style/style.css
qhp.QtVirtualKeyboard.filterAttributes = qtvirtualkeyboard 1.0 qtrefdoc
qhp.QtVirtualKeyboard.customFilters.Qt.name = QtVirtualKeyboard 1.0
@@ -54,3 +50,7 @@ qhp.QtVirtualKeyboard.subprojects.examples.title = Examples
qhp.QtVirtualKeyboard.subprojects.examples.indexTitle = Qt Virtual Keyboard Examples
qhp.QtVirtualKeyboard.subprojects.examples.selectors = fake:example
qhp.QtVirtualKeyboard.subprojects.examples.sortPages = true
+
+navigation.landingpage = "Qt Virtual Keyboard"
+navigation.qmltypespage = "Qt Virtual Keyboard QML Types"
+navigation.cppclassespage = "Qt Virtual Keyboard C++ Classes"
diff --git a/src/virtualkeyboard/doc/src/snippets/CustomInputMethod.qml b/src/virtualkeyboard/doc/snippets/CustomInputMethod.qml
index 3c94cff8..3c94cff8 100644
--- a/src/virtualkeyboard/doc/src/snippets/CustomInputMethod.qml
+++ b/src/virtualkeyboard/doc/snippets/CustomInputMethod.qml
diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-examples.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-examples.qdoc
index 109b89a4..204fbc53 100644
--- a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-examples.qdoc
+++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-examples.qdoc
@@ -24,7 +24,7 @@
/*!
\title Qt Quick Virtual Keyboard Example
- \example virtualkeyboard
+ \example enterprise/virtualkeyboard/virtualkeyboard
\brief This is an example virtual keyboard written in QML.
\ingroup qtvirtualkeyboard-examples
\image virtualkeyboard-demo.png
diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
index 99552af7..3af8e9b6 100644
--- a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
+++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
@@ -21,7 +21,7 @@
\page index.html
The Qt Virtual Keyboard project provides an input framework and reference
- keyboard frontend for Qt 5.
+ keyboard frontend for Qt 5 on Linux Desktop/X11 or Boot2Qt targets.
The input framework makes it easy to write custom input methods or to
integrate 3rd party input engines. The input methods can be implemented