diff options
| author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2014-10-17 15:55:53 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-01-05 16:59:36 +0100 |
| commit | 060cc3c47062a35e8127413ece57573d1aca067f (patch) | |
| tree | f470e22b330ae41026949b3491a1f5e241564139 /src/xmlpatterns/doc/qtxmlpatterns.qdocconf | |
| parent | 64dcf54e06556f951dff277feb9a9b6aa7767cf8 (diff) | |
| download | qtxmlpatterns-060cc3c47062a35e8127413ece57573d1aca067f.tar.gz | |
- Add \brief commands to example docs to show descriptions
- Add an examples page with the \group command
- Link to the examples page from the module index page
- Edit the .qdocconf file
- Edit the .gitignore file to allow pushing changes to examples
- Add a generic thumbnail image for C++ Code Analyzer example
Change-Id: I1a313ae26664ce9fc50ef8962f0facd57dea546b
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/xmlpatterns/doc/qtxmlpatterns.qdocconf')
| -rw-r--r-- | src/xmlpatterns/doc/qtxmlpatterns.qdocconf | 36 |
1 files changed, 12 insertions, 24 deletions
diff --git a/src/xmlpatterns/doc/qtxmlpatterns.qdocconf b/src/xmlpatterns/doc/qtxmlpatterns.qdocconf index dc0a265..4ff60e5 100644 --- a/src/xmlpatterns/doc/qtxmlpatterns.qdocconf +++ b/src/xmlpatterns/doc/qtxmlpatterns.qdocconf @@ -1,15 +1,13 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -# Name of the project which must match the outputdir. Determines the .index file project = QtXmlPatterns +description = Qt XML Patterns Reference Documentation +version = $QT_VERSION -# 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 += ../../../examples \ +examplesinstallpath = xmlpatterns + +exampledirs += ../../../examples/xmlpatterns \ + ../ \ snippets headerdirs += .. @@ -18,33 +16,23 @@ sourcedirs += .. depends += qtcore qtxml qtwidgets qtdesigner qtdoc -# 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 = QtXmlPatterns -# Sets the name of the output qhp file. qhp.QtXmlPatterns.file = qtxmlpatterns.qhp - -# Namespace for the output file. This namespace is used to distinguish between -# different documentation files in Creator/Assistant. qhp.QtXmlPatterns.namespace = org.qt-project.qtxmlpatterns.$QT_VERSION_TAG - -# Title for the package, will be the main title for the package in -# Assistant/Creator. qhp.QtXmlPatterns.indexTitle = Qt XML Patterns - -# Only update the name of the project for the next variables. qhp.QtXmlPatterns.virtualFolder = qtxmlpatterns + qhp.QtXmlPatterns.subprojects = classes qhp.QtXmlPatterns.subprojects.classes.title = C++ Classes qhp.QtXmlPatterns.subprojects.classes.indexTitle = Qt XML Patterns C++ Classes qhp.QtXmlPatterns.subprojects.classes.selectors = class fake:headerfile qhp.QtXmlPatterns.subprojects.classes.sortPages = true +tagfile = ../../../doc/qtxmlpatterns/qtxmlpatterns.tags + +# Use a generic thumbnail image for examples that have no images in their docs +manifestmeta.thumbnail.names += "QtXmlPatterns/C++ Source Code Analyzer Example" + navigation.landingpage = "Qt XML Patterns" navigation.cppclassespage = "Qt XML Patterns C++ Classes" |