HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r2418:d84ad300b3d2

Add assistant (qch) documentation generation...

Miikka Heikkinen -

r2418:d84ad300b3d2

parent child

Context file:

r2418:d84ad300b3d2

Collapse all files

doc/qchart-qch.qdocconf created 644 +27 0

@@ -0,0 +1,27
	1	qhp.projects = QtCommercialCharts
	2	qhp.QtCommercialCharts.file = qtcommercialcharts.qhp
	3	qhp.QtCommercialCharts.namespace = com.digia.qtcommercialcharts.$QT_CHARTS_VERSION_TAG
	4	qhp.QtCommercialCharts.virtualFolder = doc
	5	qhp.QtCommercialCharts.indexTitle = QtCommercial Charts Reference $QT_CHARTS_VERSION
	6	qhp.QtCommercialCharts.filterAttributes = qtcommercialcharts $QT_CHARTS_VERSION
	7	qhp.QtCommercialCharts.customFilters.QtCommercialCharts.name = QtCommercial Charts $QT_CHARTS_VERSION
	8	qhp.QtCommercialCharts.customFilters.QtCommercialCharts.filterAttributes = qtcommercialcharts $QT_CHARTS_VERSION
	9	qhp.QtCommercialCharts.indexRoot =
	10
	11	# Files not referenced in any qdoc file.
	12	# See also extraimages.HTML
	13	qhp.QtCommercialCharts.extraFiles = index.html \
	14	examples.html \
	15	demos.html \
	16	images/arrow_down.png \
	17	images/bg.png \
	18	images/breadcrumb.png \
	19	images/bullet_gt.png \
	20	images/bullet_dn.png \
	21	images/bullet_sq.png \
	22	images/bullet_up.png \
	23	images/digia_logo.png \
	24	images/horBar.png \
	25	images/qcharts.png \
	26	images/qt_commercial_logo.png \
	27	style/offline.css

charts.pro +22 -3

             !include(config.pri) {
                 error('Missing config.pri')
             }
             TEMPLATE = subdirs
             SUBDIRS = src plugins demos examples tests
             development_build: message('Development build')
             CONFIG += ordered
             QMAKE_CXXFLAGS += -g -Wall
             unix:QMAKE_DISTCLEAN += -r build bin include lib doc/html
             win32:QMAKE_DISTCLEAN += /Q /s build bin include lib doc\\html
             # install feature file
             feature.path = $$[QT_INSTALL_DATA]/mkspecs/features
             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 = qch_docs FORCE
-            docs.depends = FORCE
+            qch_docs.target = qch_docs
-            QMAKE_EXTRA_TARGETS += 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:{
                 QMAKE_DISTCLEAN += -r ./coverage
                 QMAKE_CLEAN += build/*.gcda build/*.gcno
                 QMAKE_EXTRA_TARGETS +=  buildcoverage runcoverage gencoverage
                 buildcoverage.target = build_coverage
                 buildcoverage.depends = all
                 buildcoverage.commands = mkdir -p ./coverage; \
                                          make -C src prepare_coverage;
                 runcoverage.target = run_coverage
                 runcoverage.depends = buildcoverage
                 runcoverage.commands = for f in `ls ./bin/tst_*` ; do echo "processing \$\$f test..."; \$\$f >> unit.log; done ; exit 0;
                 gencoverage.target = gen_coverage
                 gencoverage.depends = runcoverage
                 gencoverage.commands =  make -C src gen_coverage; \
                                         genhtml  -o ./coverage ./coverage/coverage.info --prefix $$PWD
             }

doc/qchart-html-template.qdocconf 0 -13

             include(qchart-html.qdocconf)
             HTML.postheader = \
                 "<div class=\"header\" id=\"qtdocheader\">\n" \
                 "  <div class=\"content\"> \n" \
                 "    <img src=\"images/qcharts.png\" alt=\"qcharts\"/>\n" \
                 "    <p class=\"qtref\"> \n" \
                 "       <span>Reference Documentation</span>\n" \
                 "    </p>\n" \
                 "  </div>\n" \
                 "  <div class=\"breadcrumb toolblock\">\n" \
                 "    <ul>\n" \
                 "      <li class=\"first\"><a href=\"index.html\">About</a></li>\n" \
                 "      <li><a href=\"gettingstarted.html\">Getting started</a></li>\n" \
                 "      <li><a href=\"classes.html\">API Classes</a></li>\n" \
                 "      <li><a href=\"qml.html\">QML API</a></li>\n" \
                 "      <li><a href=\"examples.html\">Examples</a></li>\n" \
                 "      <li><a href=\"demos.html\">Demos</a></li>\n" \
                 "      <!--  Breadcrumbs go here -->\n"
             HTML.postpostheader = \
                 "    </ul>\n" \
                 "  </div>\n" \
                 "</div>\n" \
                 "<div class=\"content mainContent\">\n"
             HTML.footer = \
                 "  <div class=\"ft\">\n" \
                 "    <span></span>\n" \
                 "  </div>\n" \
                 "</div> \n" \
                 "<div class=\"footer\">\n" \
                 "  <p>\n" \
                 "     <acronym title=\"Copyright\">&copy;</acronym> 2012 Digia ." \
                 "     Qt and Qt logos are trademarks of of Digia Corporation \n" \
                 "     in Finland and/or other countries worldwide.</p>\n" \
                 "  <p>\n" \
                 "     All other trademarks are property of their respective owners.</p>\n" \
                 "  <br />\n" \
                 "  <p>\n" \
                 "    Licensees holding valid Qt Commercial licenses may use this document in accordance with the" \
                 "    Qt Commercial License Agreement provided with the Software or, alternatively, in accordance" \
                 "    with the terms contained in a written agreement between you and Digia.</p>\n" \
                 "  <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

doc/qcharts.qdocconf +1 0

             include(compat.qdocconf)
             include(macros.qdocconf)
             include(qchart-html-template.qdocconf)
+            include(qchart-qch.qdocconf)
             project = QtCommercialCharts
             description = Library for creating charts
             sourcedirs = ../src \
                          ../examples \
                          ./src \
                          ../plugins/declarative
             headerdirs = ../src \
                          ../examples \
                          ../plugins/declarative
             exampledirs = ../ \
                           ../src \
                           ../examples
             excludefiles += ../examples/linechart/linechart.pro
             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
             imagedirs = ./images
             outputdir = ./html
             Cpp.ignoretokens        = QTCOMMERCIALCHART_EXPORT \
                                       QTCOMMERCIALCHART_END_NAMESPACE \
                                       QTCOMMERCIALCHART_BEGIN_NAMESPACE
             Cpp.ignoredirectives    = Q_DECLARE_HANDLE \
                                       Q_DECLARE_INTERFACE \
                                       Q_DECLARE_METATYPE \
                                       Q_DECLARE_OPERATORS_FOR_FLAGS \
                                       Q_DECLARE_PRIVATE \
                                       Q_DECLARE_PUBLIC \
                                       Q_DECLARE_SHARED \
                                       Q_DECLARE_TR_FUNCTIONS \
                                       Q_DECLARE_TYPEINFO \
                                       Q_DISABLE_COPY \
                                       QT_FORWARD_DECLARE_CLASS \
                                       Q_DUMMY_COMPARISON_OPERATOR \
                                       Q_ENUMS \
                                       Q_FLAGS \
                                       Q_INTERFACES \
                                       __attribute__

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages