From d84ad300b3d2a146c4dde7d2ca7faeead9b7ca4f 2013-02-08 13:38:03
From: Miikka Heikkinen <miikka.heikkinen@digia.com>
Date: 2013-02-08 13:38:03
Subject: [PATCH] Add assistant (qch) documentation generation

Modified "docs" target to generate both html and qch documentation.
"html_docs" target can be used if only html docs are required.
Qch documentation is generated under "doc/qch" folder.

Task-number: QTRD-1480
Reviewed-by: Mika Salmela

---

diff --git a/charts.pro b/charts.pro
index 4d34e7e..9f0ad9d 100644
--- a/charts.pro
+++ b/charts.pro
@@ -18,22 +18,41 @@ feature.files = $$PWD/features/qtcommercialchart.prf
 INSTALLS += feature
 
 # docs
+CHARTS_VERSION = 1.2.1
+CHARTS_VERSION_TAG = 121
+
 win32: {
     QDOC_CONF = $$CHART_BUILD_DOC_DIR\\qcharts.qdocconf
+    VERSION_SETTINGS = \
+        set QT_CHARTS_VERSION=$$CHARTS_VERSION $$escape_expand(\\n\\t) \
+        set QT_CHARTS_VERSION_TAG=$$CHARTS_VERSION_TAG $$escape_expand(\\n\\t)
 } else {
     QDOC_CONF = $$CHART_BUILD_DOC_DIR/qcharts.qdocconf
+    VERSION_SETTINGS = \
+        QT_CHARTS_VERSION=$$CHARTS_VERSION QT_CHARTS_VERSION_TAG=$$CHARTS_VERSION_TAG
 }
 
 contains(QT_MAJOR_VERSION, 5) {
     QDOC_CMD = qdoc
+    HELPGENERATOR_CMD = qhelpgenerator -platform minimal
 } else {
     QDOC_CMD = qdoc3
+    HELPGENERATOR_CMD = qhelpgenerator
 }
 
+QHP_FILE = doc/html/qtcommercialcharts.qhp
+QCH_FILE = doc/qch/qtcommercialcharts.qch
+
 docs.target = docs
-docs.commands = $$QDOC_CMD $$QDOC_CONF
-docs.depends = FORCE
-QMAKE_EXTRA_TARGETS += docs
+docs.depends = qch_docs FORCE
+qch_docs.target = qch_docs
+qch_docs.commands = $$HELPGENERATOR_CMD $$QHP_FILE -o $$QCH_FILE
+qch_docs.depends = html_docs FORCE
+html_docs.target = html_docs
+html_docs.commands = $$VERSION_SETTINGS $$QDOC_CMD $$QDOC_CONF
+html_docs.depends = FORCE
+
+QMAKE_EXTRA_TARGETS += docs qch_docs html_docs
 
 # coverage
 unix:coverage:{
diff --git a/doc/qchart-html-template.qdocconf b/doc/qchart-html-template.qdocconf
index db7a3c3..e2d2305 100644
--- a/doc/qchart-html-template.qdocconf
+++ b/doc/qchart-html-template.qdocconf
@@ -44,16 +44,3 @@ HTML.footer = \
     "  <p>\n" \
     "     <img src=\"images/digia_logo.png\" alt=\"digia\" /></p>\n" \
     "</div>\n" \
-
-# Files not referenced in any qdoc file.
-# See also extraimages.HTML
-qhp.QDoc.extraFiles = index.html \
-                      images/arrow_down.png \
-                      images/breadcrumb.png \
-                      images/bullet_gt.png \
-                      images/bullet_dn.png \
-                      images/bullet_sq.png \
-                      images/bullet_up.png \
-                      images/horBar.png \
-                      images/qcharts.png \
-                      style/offline.css
diff --git a/doc/qchart-qch.qdocconf b/doc/qchart-qch.qdocconf
new file mode 100644
index 0000000..0919064
--- /dev/null
+++ b/doc/qchart-qch.qdocconf
@@ -0,0 +1,27 @@
+qhp.projects                            = QtCommercialCharts
+qhp.QtCommercialCharts.file             = qtcommercialcharts.qhp
+qhp.QtCommercialCharts.namespace        = com.digia.qtcommercialcharts.$QT_CHARTS_VERSION_TAG
+qhp.QtCommercialCharts.virtualFolder    = doc
+qhp.QtCommercialCharts.indexTitle       = QtCommercial Charts Reference $QT_CHARTS_VERSION
+qhp.QtCommercialCharts.filterAttributes = qtcommercialcharts $QT_CHARTS_VERSION
+qhp.QtCommercialCharts.customFilters.QtCommercialCharts.name = QtCommercial Charts $QT_CHARTS_VERSION
+qhp.QtCommercialCharts.customFilters.QtCommercialCharts.filterAttributes = qtcommercialcharts $QT_CHARTS_VERSION
+qhp.QtCommercialCharts.indexRoot        =
+
+# Files not referenced in any qdoc file.
+# See also extraimages.HTML
+qhp.QtCommercialCharts.extraFiles = index.html \
+                                    examples.html \
+                                    demos.html \
+                                    images/arrow_down.png \
+                                    images/bg.png \
+                                    images/breadcrumb.png \
+                                    images/bullet_gt.png \
+                                    images/bullet_dn.png \
+                                    images/bullet_sq.png \
+                                    images/bullet_up.png \
+                                    images/digia_logo.png \
+                                    images/horBar.png \
+                                    images/qcharts.png \
+                                    images/qt_commercial_logo.png \
+                                    style/offline.css
diff --git a/doc/qcharts.qdocconf b/doc/qcharts.qdocconf
index a65f7a0..613dd25 100644
--- a/doc/qcharts.qdocconf
+++ b/doc/qcharts.qdocconf
@@ -1,6 +1,7 @@
 include(compat.qdocconf)
 include(macros.qdocconf)
 include(qchart-html-template.qdocconf)
+include(qchart-qch.qdocconf)
 
 project = QtCommercialCharts
 description = Library for creating charts