summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@nokia.com>2012-03-19 11:00:22 +0100
committerLeena Miettinen <riitta-leena.miettinen@nokia.com>2012-03-19 11:07:06 +0100
commit0e54ad82283048e9f23b4969a709fcf283d245f1 (patch)
tree39139d8b4f0137b3d038439dd7bc4c823c52804b /doc
parentf60c03d5bb03ba42955ce309a1765795f33e9bc1 (diff)
Doc: add config for help online style
Needed on qt-project.org Change-Id: I99f7cd61fa260e315f3bca6737be103e0587876e Reviewed-by: Niels Weber <niels.2.weber@nokia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/config/installerfw-project.qdocconf36
-rw-r--r--doc/config/qt-html-templates-online.qdocconf68
-rw-r--r--doc/config/qt-html-templates.qdocconf32
-rw-r--r--doc/doc.pri13
-rw-r--r--doc/installerfw-online.qdocconf4
-rw-r--r--doc/installerfw.qdocconf38
6 files changed, 104 insertions, 87 deletions
diff --git a/doc/config/installerfw-project.qdocconf b/doc/config/installerfw-project.qdocconf
new file mode 100644
index 000000000..40f8469d9
--- /dev/null
+++ b/doc/config/installerfw-project.qdocconf
@@ -0,0 +1,36 @@
+project = "Qt Installer Framework Manual"
+description = "Qt Installer Framework Manual"
+
+headerdirs =
+sourcedirs = $SRCDIR
+imagedirs = $SRCDIR/images $SRCDIR/templates/images
+outputdir = $OUTDIR
+exampledirs = $SRCDIR
+indexes = qt.index
+
+include(compat.qdocconf)
+include(macros.qdocconf)
+include(qt-cpp-ignore.qdocconf)
+include(qt-defines.qdocconf)
+
+sources.fileextensions = "*.qdoc"
+
+qhp.projects = InstallerFramework
+qhp.InstallerFramework.file = installerfw.qhp
+qhp.InstallerFramework.namespace = com.nokia.qt.installerfw.121
+qhp.InstallerFramework.virtualFolder = doc
+qhp.InstallerFramework.indexTitle = Qt Installer Framework Manual
+qhp.InstallerFramework.filterAttributes = installerfw 121
+qhp.InstallerFramework.customFilters.InstallerFramework.name = Installer Framework
+qhp.InstallerFramework.customFilters.InstallerFramework.filterAttributes = installerfw
+qhp.InstallerFramework.indexRoot =
+
+qhp.InstallerFramework.subprojects = manual
+qhp.InstallerFramework.subprojects.manual.title = Qt Installer Framework Manual
+qhp.InstallerFramework.subprojects.manual.indexTitle = Qt Installer Framework Manual
+qhp.InstallerFramework.subprojects.manual.type = manual
+
+# Doxygen compatibility commands
+
+macro.see = "\\sa"
+macro.function = "\\fn"
diff --git a/doc/config/qt-html-templates-online.qdocconf b/doc/config/qt-html-templates-online.qdocconf
index f99402d45..3d96e457e 100644
--- a/doc/config/qt-html-templates-online.qdocconf
+++ b/doc/config/qt-html-templates-online.qdocconf
@@ -5,21 +5,21 @@ HTML.postheader = \
" <div class=\"content\"> \n" \
" <div id=\"nav-logo\">\n" \
" <a href=\"index.html\">Home</a></div>\n" \
- " <a href=\"index.html\" class=\"qtref\"><span>Qt Creator Manual</span></a>\n" \
+ " <a href=\"index.html\" class=\"qtref\"><span>Qt Installer Framework Manual</span></a>\n" \
" <div id=\"narrowsearch\"></div>\n" \
" <div id=\"nav-topright\">\n" \
" <ul>\n" \
" <li class=\"nav-topright-home\"><a href=\"http://qt.nokia.com/\">Qt HOME</a></li>\n" \
- " <li class=\"nav-topright-dev\"><a href=\"http://developer.qt.nokia.com/\">DEV</a></li>\n" \
+ " <li class=\"nav-topright-dev\"><a href=\"http://qt-project.org/\">DEV</a></li>\n" \
" <li class=\"nav-topright-labs\"><a href=\"http://labs.qt.nokia.com/blogs/\">LABS</a></li>\n" \
- " <li class=\"nav-topright-doc nav-topright-doc-active\"><a href=\"http://doc.qt.nokia.com/\">\n" \
+ " <li class=\"nav-topright-doc nav-topright-doc-active\"><a href=\"http://qt-project.org/doc/\">\n" \
" DOC</a></li>\n" \
" <li class=\"nav-topright-blog\"><a href=\"http://blog.qt.nokia.com/\">BLOG</a></li>\n" \
" </ul>\n" \
" </div>\n" \
" <div id=\"shortCut\">\n" \
" <ul>\n" \
- " <li class=\"shortCut-topleft-inactive\"><span><a href=\"index.html\">Qt Creator</a></span></li>\n" \
+ " <li class=\"shortCut-topleft-inactive\"><span><a href=\"index.html\">Qt Installer Framework</a></span></li>\n" \
" </a></li>\n" \
" </ul>\n" \
" </div>\n" \
@@ -36,12 +36,12 @@ HTML.postheader = \
" API Lookup</h2>\n" \
" <div id=\"list001\" class=\"list\">\n" \
" <ul id=\"ul001\" >\n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/classes.html">Class index</a></li>\n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/functions.html">Function index</a></li>\n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/modules.html">Modules</a></li>\n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/namespaces.html">Namespaces</a></li>\n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/qtglobal.html">Global Declarations</a></li>\n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/qdeclarativeelements.html">QML elements</a></li>\n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/classes.html">Class index</a></li>\n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/functions.html">Function index</a></li>\n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/modules.html">Modules</a></li>\n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/namespaces.html">Namespaces</a></li>\n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/qtglobal.html">Global Declarations</a></li>\n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/qdeclarativeelements.html">QML elements</a></li>\n" \
" </ul> \n" \
" </div>\n" \
" </div>\n" \
@@ -50,13 +50,13 @@ HTML.postheader = \
" Qt Topics</h2>\n" \
" <div id=\"list002\" class=\"list\">\n" \
" <ul id=\"ul002\" >\n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/qt-basic-concepts.html">Programming with Qt</a></li> \n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/qtquick.html">Device UIs &amp; Qt Quick</a></li> \n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/qt-gui-concepts.html">UI Design with Qt</a></li> \n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/developing-with-qt.html">Cross-platform and Platform-specific</a></li> \n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/platform-specific.html">Platform-specific info</a></li> \n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/technology-apis.html">Qt and Key Technologies</a></li> \n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/best-practices.html">How-To's and Best Practices</a></li> \n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/qt-basic-concepts.html">Programming with Qt</a></li> \n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/qtquick.html">Device UIs &amp; Qt Quick</a></li> \n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/qt-gui-concepts.html">UI Design with Qt</a></li> \n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/developing-with-qt.html">Cross-platform and Platform-specific</a></li> \n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/platform-specific.html">Platform-specific info</a></li> \n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/technology-apis.html">Qt and Key Technologies</a></li> \n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/best-practices.html">Best Practices</a></li> \n" \
" </ul> \n" \
" </div>\n" \
" </div>\n" \
@@ -65,10 +65,10 @@ HTML.postheader = \
" Examples</h2>\n" \
" <div id=\"list003\" class=\"list\">\n" \
" <ul id=\"ul003\">\n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/all-examples.html">Examples</a></li>\n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/tutorials.html">Tutorials</a></li>\n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/demos.html">Demos</a></li>\n" \
- " <li><a href="http://doc.qt.nokia.com/4.7/qdeclarativeexamples.html">QML Examples</a></li>\n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/all-examples.html">Examples</a></li>\n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/tutorials.html">Tutorials</a></li>\n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/demos.html">Demos</a></li>\n" \
+ " <li><a href="http://qt-project.org/doc/qt-4.8/qdeclarativeexamples.html">QML Examples</a></li>\n" \
" </ul> \n" \
" </div>\n" \
" </div>\n" \
@@ -105,21 +105,23 @@ HTML.footer = \
" </div> \n" \
" <div class=\"footer\">\n" \
" <p>\n" \
- " <acronym title=\"Copyright\">&copy;</acronym> 2008-2012 Nokia Corporation and/or its\n" \
- " subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation \n" \
- " in Finland and/or other countries worldwide.</p>\n" \
- " <p>\n" \
- " All other trademarks are property of their respective owners. <a title=\"Privacy Policy\"\n" \
- " href=\"http://qt.nokia.com/about/privacy-policy\">Privacy Policy</a></p>\n" \
+ " <acronym title=\"Copyright\">&copy;</acronym> 2012 Nokia Corporation and/or its\n" \
+ " subsidiaries. Documentation contributions included herein are the copyrights of\n" \
+ " 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 Nokia.</p>\n" \
+ " The documentation provided herein is licensed under the terms of the\n" \
+ " <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU Free Documentation\n" \
+ " License version 1.3</a> as published by the Free Software Foundation.</p>\n" \
+ " <p>\n" \
+ " Documentation sources may be obtained from <a href=\"http://www.qt-project.org\">\n" \
+ " www.qt-project.org</a>.</p>\n" \
+ " <br />\n" \
" <p>\n" \
- " Alternatively, this document may be used under the terms of the <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU\n" \
- " Free Documentation License version 1.3</a>\n" \
- " as published by the Free Software Foundation.</p>\n" \
+ " Nokia, Qt and their respective logos are trademarks of Nokia Corporation \n" \
+ " in Finland and/or other countries worldwide. All other trademarks are property\n" \
+ " of their respective owners. <a title=\"Privacy Policy\"\n" \
+ " href=\"http://en.gitorious.org/privacy_policy/\">Privacy Policy</a></p>\n" \
" </div>\n" \
"\n" \
" <script src=\"scripts/functions.js\" type=\"text/javascript\"></script>\n" \
diff --git a/doc/config/qt-html-templates.qdocconf b/doc/config/qt-html-templates.qdocconf
index b0b969330..cbdae8df6 100644
--- a/doc/config/qt-html-templates.qdocconf
+++ b/doc/config/qt-html-templates.qdocconf
@@ -24,21 +24,23 @@ HTML.footer = \
"</div> \n" \
"<div class=\"footer\">\n" \
" <p>\n" \
- " <acronym title=\"Copyright\">&copy;</acronym> 2008-2012 Nokia Corporation and/or its\n" \
- " subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation \n" \
- " in Finland and/or other countries worldwide.</p>\n" \
- " <p>\n" \
- " All other trademarks are property of their respective owners. <a title=\"Privacy Policy\"\n" \
- " href=\"http://qt.nokia.com/about/privacy-policy\">Privacy Policy</a></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 Nokia.</p>\n" \
- " <p>\n" \
- " Alternatively, this document may be used under the terms of the <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU\n" \
- " Free Documentation License version 1.3</a>\n" \
- " as published by the Free Software Foundation.</p>\n" \
+ " <acronym title=\"Copyright\">&copy;</acronym> 2012 Nokia Corporation and/or its\n" \
+ " subsidiaries. Documentation contributions included herein are the copyrights of\n" \
+ " their respective owners.</p>\n" \
+ " <br />\n" \
+ " <p>\n" \
+ " The documentation provided herein is licensed under the terms of the\n" \
+ " <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU Free Documentation\n" \
+ " License version 1.3</a> as published by the Free Software Foundation.</p>\n" \
+ " <p>\n" \
+ " Documentation sources may be obtained from <a href=\"http://www.qt-project.org\">\n" \
+ " www.qt-project.org</a>.</p>\n" \
+ " <br />\n" \
+ " <p>\n" \
+ " Nokia, Qt and their respective logos are trademarks of Nokia Corporation \n" \
+ " in Finland and/or other countries worldwide. All other trademarks are property\n" \
+ " of their respective owners. <a title=\"Privacy Policy\"\n" \
+ " href=\"http://en.gitorious.org/privacy_policy/\">Privacy Policy</a></p>\n" \
"</div>\n" \
# Files not referenced in any qdoc file.
diff --git a/doc/doc.pri b/doc/doc.pri
index 63e45ae0d..974013761 100644
--- a/doc/doc.pri
+++ b/doc/doc.pri
@@ -18,7 +18,14 @@ QCH_FILE = $$OUT_PWD/doc/installerfw.qch
HELP_DEP_FILES = $$PWD/installerfw.qdoc \
$$PWD/scripting.qdoc \
- $$PWD/installerfw.qdocconf
+ $$PWD/installerfw.qdocconf \
+ $$PWD/installerfw-online.qdocconf \
+ $$PWD/config/compat.qdocconf \
+ $$PWD/config/macros.qdocconf \
+ $$PWD/config/qt-cpp-ignore.qdocconf \
+ $$PWD/config/qt-defines.qdocconf \
+ $$PWD/config/qt-html-templates.qdocconf \
+ $$PWD/config/qt-html-default-styles.qdocconf
unix {
html_docs.commands = $$QDOC $$PWD/installerfw.qdocconf
@@ -29,9 +36,9 @@ html_docs.depends += $$HELP_DEP_FILES
html_docs.files = $$QHP_FILE
unix {
-html_docs_online.commands = $$QDOC $$PWD/installerfw.qdocconf
+html_docs_online.commands = $$QDOC $$PWD/installerfw-online.qdocconf
} else {
-html_docs_online.commands = \"$$QDOC $$PWD/installerfw.qdocconf\"
+html_docs_online.commands = \"$$QDOC $$PWD/installerfw-online.qdocconf\"
}
html_docs_online.depends += $$HELP_DEP_FILES
html_docs_online.files = $$QHP_FILE
diff --git a/doc/installerfw-online.qdocconf b/doc/installerfw-online.qdocconf
new file mode 100644
index 000000000..2d04e92b1
--- /dev/null
+++ b/doc/installerfw-online.qdocconf
@@ -0,0 +1,4 @@
+# Run qdoc from the directory that contains this file.
+include(config/installerfw-project.qdocconf)
+include(config/qt-html-templates-online.qdocconf)
+
diff --git a/doc/installerfw.qdocconf b/doc/installerfw.qdocconf
index 9972287d8..06edad086 100644
--- a/doc/installerfw.qdocconf
+++ b/doc/installerfw.qdocconf
@@ -1,37 +1,3 @@
-project = "Qt Installer Framework Manual"
-description = "Qt Installer Framework Manual"
-
-headerdirs =
-sourcedirs = $SRCDIR
-imagedirs = $SRCDIR/images $SRCDIR/templates/images
-outputdir = $OUTDIR
-exampledirs = $SRCDIR
-indexes = qt.index
-
+# Run qdoc from the directory that contains this file.
+include(config/installerfw-project.qdocconf)
include(config/qt-html-templates.qdocconf)
-include(config/compat.qdocconf)
-include(config/macros.qdocconf)
-include(config/qt-cpp-ignore.qdocconf)
-include(config/qt-defines.qdocconf)
-
-sources.fileextensions = "*.qdoc"
-
-qhp.projects = InstallerFramework
-qhp.InstallerFramework.file = installerfw.qhp
-qhp.InstallerFramework.namespace = com.nokia.qt.installerfw.121
-qhp.InstallerFramework.virtualFolder = doc
-qhp.InstallerFramework.indexTitle = Qt Installer Framework Manual
-qhp.InstallerFramework.filterAttributes = installerfw 121
-qhp.InstallerFramework.customFilters.InstallerFramework.name = Installer Framework
-qhp.InstallerFramework.customFilters.InstallerFramework.filterAttributes = installerfw
-qhp.InstallerFramework.indexRoot =
-
-qhp.InstallerFramework.subprojects = manual
-qhp.InstallerFramework.subprojects.manual.title = Qt Installer Framework Manual
-qhp.InstallerFramework.subprojects.manual.indexTitle = Qt Installer Framework Manual
-qhp.InstallerFramework.subprojects.manual.type = manual
-
-# Doxygen compatibility commands
-
-macro.see = "\\sa"
-macro.function = "\\fn"