diff options
| author | Jerome Pasion <jerome.pasion@nokia.com> | 2011-09-30 16:08:08 +0200 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2011-10-05 14:31:40 +0200 |
| commit | 884c0f6bf0246c128e3b6786f00fe5de3f3f9f6e (patch) | |
| tree | 7be1c09b90d5b55256d411bd7f3f826270995ebc /doc/config/qtquick.qdocconf | |
| parent | 2dbb77584a26b8de5f84124498059d9f811a23dd (diff) | |
Doc: Adding qtdeclarative documentation configuration files.
We need a modularized Qt Quick documentation package that only
contains Qt Quick 2.
Add a make target for the documentation.
Copied Qt 5's offline style as a starting CSS template.
Change-Id: I2298f23c7695ebbe38f43b89626431a2e8059a9a
Reviewed-on: http://codereview.qt-project.org/5891
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
Diffstat (limited to 'doc/config/qtquick.qdocconf')
| -rw-r--r-- | doc/config/qtquick.qdocconf | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/doc/config/qtquick.qdocconf b/doc/config/qtquick.qdocconf new file mode 100644 index 0000000000..3f8988e549 --- /dev/null +++ b/doc/config/qtquick.qdocconf @@ -0,0 +1,84 @@ +# Name of the project. +project = Qt Quick +description = Qt Quick Documentation + +# Directories in which to search for files to document and images. +# By default set to the root directory of the project for sources +# and headers and qdoc will therefore generate output for each file. +# Images should be placed in <rootdir>/dic/images and examples in +# <rootdir>/examples. +# Paths are relative to the location of this file. + +exampledirs += ../src/examples \ + ../.. \ + ../../examples + +headerdirs += ../src \ + ../../src + +imagedirs += ../src/images \ + +sourcedirs += ../src \ + ../../src + +excludedirs += ../src/qtquick1 \ + ../../src/qtquick1 + +#indexes = $QT5DOC/doc/html/qt.index + +# The following parameters are for creating a qhp file, the qhelpgenerator +# program can convert the qhp file into a qch file which can be opened in +# Qt Assistant and/or Qt Creator. + +# Defines the name of the project. You cannot use operators (+, =, -) in +# the name. Properties for this project are set using a qhp.<projectname>.property +# format. +qhp.projects = qtquick + +# Sets the name of the output qhp file. +qhp.qtquick.file = qtquick.qhp + +# Namespace for the output file. This namespace is used to distinguish between +# different documentation files in Creator/Assistant. Normal format for MP +# projects should be: com.nokia.mp.<projectname>.version with version being +# a number containing a major, minor and revision element. E.g. version 1.0 +# becomes 100. +qhp.qtquick.namespace = qtquick.200 + +# Title for the package, will be the main title for the package in +# Assistant/Creator. +qhp.qtquick.indexTitle = Qt Quick Documentation + +# Extra files to add to the output which are not linked to from anywhere +# using a qdoc \l command. +qhp.qtquick.extraFiles = style/qtquick.css \ + index.html + +# Only update the name of the project for the next variables. +qhp.qtquick.virtualFolder = qdoc +qhp.qtquick.subprojects = classes +qhp.qtquick.subprojects.classes.title = Classes +qhp.qtquick.subprojects.classes.selectors = class fake:headerfile +qhp.qtquick.subprojects.classes.sortPages = true + + + +# Do NOT change the variables after this line unless you know what you are doing. + +outputdir = ../html +outputformats = HTML + +examples.fileextensions = "*.cpp *.h *.js *.svg *.xml *.ui *.qml" +examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng" +headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx" +sources.fileextensions = "*.cpp *.qdoc *.mm *.qml" + +HTML.nobreadcrumbs = "true" + +HTML.templatedir = . +HTML.stylesheets = style/qtquick.css + +HTML.headerstyles = " <link rel=\"stylesheet\" type=\"text/css\" href=\"style/qtquick.css\" />\n" +HTML.endheader = "</head>\n<body>\n" + +HTML.footer = "<div class=\"footer\">Copyright (c) 2011 Nokia Corporation and/or its subsidiaries. All rights reserved.</div>\n" |