doc/config/qtquick.qdocconf

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