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