doc/qt5.qdocconf

   1 # Name of the project.
   2 project = Qt Xml Patterns
   3
   4 # Directories in which to search for files to document and images.
   5 # By default set to the root directory of the project for sources
   6 # and headers and qdoc will therefore generate output for each file.
   7 # Images should be placed in <rootdir>/dic/images and examples in
   8 # <rootdir>/examples.
   9 # Paths are relative to the  location of this file.
  10 exampledirs += ../doc/src
  11 headerdirs += ..
  12 imagedirs += images
  13 sourcedirs += ..
  14
  15 # The following parameters are for creating a qhp file, the qhelpgenerator
  16 # program can convert the qhp file into a qch file which can be opened in
  17 # Qt Assistant and/or Qt Creator.
  18
  19 # Defines the name of the project. You cannot use operators (+, =, -) in
  20 # the name. Properties for this project are set using a qhp.<projectname>.property
  21 # format.
  22 qhp.projects = qtxmlpatterns
  23
  24 # Sets the name of the output qhp file.
  25 qhp.qtxmlpatterns.file = projectname.qhp
  26
  27 # Namespace for the output file. This namespace is used to distinguish between
  28 # different documentation files in Creator/Assistant.
  29 qhp.qtxmlpatterns.namespace = com.nokia.mp.projectname.100
  30
  31 # Title for the package, will be the main title for the package in
  32 # Assistant/Creator.
  33 qhp.qtxmlpatterns.indexTitle = Qt XMLPatterns Documentation
  34
  35 # Extra files to add to the output which are not linked to from anywhere
  36 # using a qdoc \l command.
  37 qhp.qtxmlpatterns.extraFiles = style/style.css \
  38                                      index.html
  39
  40 # Only updtae the name of the project for the next variables.
  41 qhp.qtxmlpatterns.virtualFolder  = qdoc
  42 qhp.qtxmlpatterns.subprojects = classes
  43 qhp.qtxmlpatterns.subprojects.classes.title = Classes
  44 qhp.qtxmlpatterns.subprojects.classes.selectors = class fake:headerfile
  45 qhp.qtxmlpatterns.subprojects.classes.sortPages = true
  46
  47
  48
  49 # Do NOT change the variables after this line unless you know what you are doing.
  50
  51 outputdir = html
  52 outputformats = HTML
  53
  54 examples.fileextensions = "*.cpp *.h *.js *.svg *.xml *.ui *.qml"
  55 examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng"
  56 headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
  57 sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
  58
  59 HTML.nobreadcrumbs = "true"
  60
  61 HTML.templatedir = .
  62 HTML.stylesheets = style/style.css
  63
  64 HTML.headerstyles = "  <link rel=\"stylesheet\" type=\"text/css\" href=\"style/style.css\" />\n"
  65 HTML.endheader = "</head>\n<body>\n"
  66
  67 HTML.footer = "<div class=\"footer\">Copyright (c) 2011 Nokia Corporation and/or its subsidiaries. All rights reserved.</div>\n"