summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFathi Boudra <fabo@debian.org>2010-07-01 16:22:15 +0300
committerFathi Boudra <fabo@debian.org>2010-07-01 16:22:15 +0300
commit5a5315a384de27326211bc2063bc305b9f8ecffd (patch)
tree420a47d6eff917e890a3448d85a92267bb0a7129 /doc
parent0aa59b3895bc4331c6e12e27f0879f1a7869b43b (diff)
Add Qt Compressed Help (qch) documentation generation
This patch replaces the previous html documentation generation system. In addition to the html documentation, it generates qch documentation for use in Qt Assistant.
Diffstat (limited to 'doc')
-rw-r--r--doc/src/doc.pri49
-rw-r--r--doc/src/qmf.qdocconf20
2 files changed, 67 insertions, 2 deletions
diff --git a/doc/src/doc.pri b/doc/src/doc.pri
new file mode 100644
index 00000000..cff437ca
--- /dev/null
+++ b/doc/src/doc.pri
@@ -0,0 +1,49 @@
+QDOC_BIN = $$targetPath($$[QT_INSTALL_BINS]/qdoc3)
+HELPGENERATOR = $$targetPath($$[QT_INSTALL_BINS]/qhelpgenerator)
+
+equals(QMAKE_DIR_SEP, /) { # unix, mingw+msys
+ QDOC = SRCDIR=$$PWD OUTDIR=$$OUT_PWD/doc/html $$QDOC_BIN
+} else:win32-g++* { # just mingw
+ # The lack of spaces in front of the && is necessary!
+ QDOC = set SRCDIR=$$PWD&& set OUTDIR=$$OUT_PWD/doc/html&& $$QDOC_BIN
+} else { # nmake
+ QDOC = set SRCDIR=$$PWD $$escape_expand(\\n\\t) \
+ set OUTDIR=$$OUT_PWD/doc/html $$escape_expand(\\n\\t) \
+ $$QDOC_BIN
+}
+
+QHP_FILE = $$OUT_PWD/doc/html/qmf.qhp
+QCH_FILE = $$OUT_PWD/doc/html/qmf.qch
+
+HELP_DEP_FILES = $$PWD/index.qdoc \
+ $$PWD/messageserver.qdoc \
+ $$PWD/messaging.qdoc \
+ $$PWD/qtmail.qdoc \
+ $$PWD/qtopiamail.qdoc \
+ $$PWD/qtopiamail_messageserver.qdoc \
+ $$PWD/qtopiamail_qmfutil.qdoc \
+ $$PWD/qmf.qdocconf \
+
+html_docs.commands = $$QDOC $$PWD/qmf.qdocconf
+html_docs.depends += $$HELP_DEP_FILES
+html_docs.files = $$QHP_FILE
+
+qch_docs.commands = $$HELPGENERATOR -o \"$$QCH_FILE\" $$QHP_FILE
+qch_docs.depends += html_docs
+qch_docs.files = $$QCH_FILE
+
+unix:!macx {
+ qch_docs.path = $$[QT_INSTALL_PREFIX]/share/qmf/doc
+ qch_docs.CONFIG += no_check_exist
+ INSTALLS += qch_docs
+}
+
+docs.depends = qch_docs
+QMAKE_EXTRA_TARGETS += html_docs qch_docs docs
+
+OTHER_FILES = $$HELP_DEP_FILES \
+ $$PWD/api/api-pages.qdoc \
+ $$PWD/api/classhierarchy.qdoc \
+ $$PWD/api/groups.qdoc \
+ $$PWD/examples/messageviewer.qdoc \
+ $$PWD/examples/messagenavigator.qdoc
diff --git a/doc/src/qmf.qdocconf b/doc/src/qmf.qdocconf
index 7a86bca9..925c9cbd 100644
--- a/doc/src/qmf.qdocconf
+++ b/doc/src/qmf.qdocconf
@@ -1,5 +1,21 @@
-project = Qtopia Messaging Framework
-description = QMF Reference Documentation
+project = Qt Messaging Framework
+description = "Qt Messaging Framework Reference Documentation"
+
+qhp.projects = QMF
+qhp.QMF.file = qmf.qhp
+qhp.QMF.namespace = com.nokia.qmf.100
+qhp.QMF.virtualFolder = doc
+qhp.QMF.indexTitle = Qt Messaging Framework
+qhp.QMF.filterAttributes = qmf 1.0.0
+qhp.QMF.customFilters.QMF.name = Qt Messaging Framework 1.0.0
+qhp.QMF.customFilters.QMF.filterAttributes = qmf 1.0.0
+qhp.QMF.indexRoot =
+qhp.QMF.extraFiles = \
+ classic.css \
+ images/codeless.png \
+ images/messagenavigator-example.png \
+ images/messageviewer-example.png \
+ images/qtlogo.png
imagedirs = images