doc/qtcreator.qdocconf

   1 # Run qdoc from the directory that contains this file.
   2 include(qt-html-templates.qdocconf)
   3
   4 project     = qtcreator
   5 description = "Qt Creator Manual"
   6
   7 headerdirs =
   8 sourcedirs =
   9 sourcedirs = $SRCDIR
  10 imagedirs = $SRCDIR/images $SRCDIR/templates/images
  11 outputdir = $OUTDIR
  12 exampledirs = $SRCDIR
  13 indexes                 = qt.index
  14
  15 include(qt-defines.qdocconf)
  16
  17 sources.fileextensions  = "qtcreator.qdoc addressbook-sdk.qdoc"
  18
  19
  20 qhp.projects            = QtCreator
  21 qhp.QtCreator.file             = qtcreator.qhp
  22 qhp.QtCreator.namespace        = com.nokia.qtcreator.2180
  23 qhp.QtCreator.virtualFolder    = doc
  24 qhp.QtCreator.indexTitle       = Qt Creator
  25 qhp.QtCreator.filterAttributes = qtcreator 2.1.80
  26 qhp.QtCreator.customFilters.QtCreator.name = Qt Creator 2.1.80
  27 qhp.QtCreator.customFilters.QtCreator.filterAttributes = qtcreator 2.1.80
  28 qhp.QtCreator.indexRoot        =
  29 qhp.QtCreator.extraFiles       = \
  30                           style/style.css \
  31                           style/style_ie6.css \
  32                           style/style_ie7.css \
  33                           style/style_ie8.css \
  34                           images/qt-logo.png \
  35                           images/qtcreator-screenshots.png \
  36                           scripts/functions.js \
  37                           scripts/jquery.js \
  38                           images/api_examples.png \
  39                           images/api_lookup.png \
  40                           images/arrow_down.png \
  41                           images/bg_ll.png \
  42                           images/bg_l.png \
  43                           images/bg_lr.png \
  44                           images/bg_r.png \
  45                           images/bg_ul_blank.png \
  46                           images/bg_ll_blank.png \
  47                           images/bg_l_blank.png \
  48                           images/breadcrumb.png \
  49                           images/bullet_dn.png \
  50                           images/bullet_gt.png \
  51                           images/bullet_sq.png \
  52                           images/box_bg.png \
  53                           images/feedbackground.png \
  54                           images/horBar.png \
  55                           images/page_bg.png \
  56                           images/page.png \
  57                           images/qt-logo.png \
  58                           images/sprites-combined.png \
  59                           images/bullet_up.png
  60
  61 qhp.QtCreator.subprojects = manual
  62 qhp.QtCreator.subprojects.manual.title = Qt Creator Manual
  63 qhp.QtCreator.subprojects.manual.indexTitle = Qt Creator Manual
  64 qhp.QtCreator.subprojects.manual.type = manual
  65
  66 # macros.qdocconf
  67
  68 macro.aring.HTML        = "&aring;"
  69 macro.Auml.HTML         = "&Auml;"
  70 macro.author            = "\\bold{Author:}"
  71 macro.br.HTML           = "<br />"
  72 macro.BR.HTML           = "<br />"
  73 macro.aacute.HTML       = "&aacute;"
  74 macro.eacute.HTML       = "&eacute;"
  75 macro.iacute.HTML       = "&iacute;"
  76 macro.gui               = "\\bold"
  77 macro.hr.HTML           = "<hr />"
  78 macro.key               = "\\bold"
  79 macro.menu              = "\\bold"
  80 macro.note              = "\\bold{Note:}"
  81 macro.oslash.HTML       = "&oslash;"
  82 macro.ouml.HTML         = "&ouml;"
  83 macro.QA                = "\\e{Qt Assistant}"
  84 macro.QD                = "\\e{Qt Designer}"
  85 macro.QL                = "\\e{Qt Linguist}"
  86 macro.QC                = "\\e{Qt Creator}"
  87 macro.QMLD              = "\\e{Qt Quick Designer}"
  88 macro.QQV               = "\\e{Qt QML Viewer}"
  89 macro.param             = "\\e"
  90 macro.raisedaster.HTML  = "<sup>*</sup>"
  91 macro.reg.HTML          = "<sup>&reg;</sup>"
  92 macro.return            = "Returns"
  93 macro.starslash         = "\\c{*/}"
  94 macro.uuml.HTML         = "&uuml;"
  95 macro.mdash.HTML        = "&mdash;"
  96
  97 # compat.qdocconf
  98
  99 alias.i                         = e
 100 alias.include                   = input
 101
 102 macro.0                         = "\\\\0"
 103 macro.b                         = "\\\\b"
 104 macro.n                         = "\\\\n"
 105 macro.r                         = "\\\\r"
 106 macro.i                         = "\\o"
 107 macro.i11                       = "\\o{1,1}"
 108 macro.i12                       = "\\o{1,2}"
 109 macro.i13                       = "\\o{1,3}"
 110 macro.i14                       = "\\o{1,4}"
 111 macro.i15                       = "\\o{1,5}"
 112 macro.i16                       = "\\o{1,6}"
 113 macro.i17                       = "\\o{1,7}"
 114 macro.i18                       = "\\o{1,8}"
 115 macro.i19                       = "\\o{1,9}"
 116 macro.i21                       = "\\o{2,1}"
 117 macro.i31                       = "\\o{3,1}"
 118 macro.i41                       = "\\o{4,1}"
 119 macro.i51                       = "\\o{5,1}"
 120 macro.i61                       = "\\o{6,1}"
 121 macro.i71                       = "\\o{7,1}"
 122 macro.i81                       = "\\o{8,1}"
 123 macro.i91                       = "\\o{9,1}"
 124 macro.img                       = "\\image"
 125 macro.endquote                  = "\\endquotation"
 126 spurious                        = "Missing comma in .*" \
 127                                   "Missing pattern .*"
 128
 129 # Doxygen compatibility commands
 130
 131 macro.see                       = "\\sa"
 132 macro.function                  = "\\fn"
 133
 134 # qt-cpp-ignore.qdocconf
 135
 136 Cpp.ignoretokens        = QAXFACTORY_EXPORT \
 137                           QDESIGNER_COMPONENTS_LIBRARY \
 138                           QDESIGNER_EXTENSION_LIBRARY \
 139                           QDESIGNER_SDK_LIBRARY \
 140                           QDESIGNER_SHARED_LIBRARY \
 141                           QDESIGNER_UILIB_LIBRARY \
 142                           QM_EXPORT_CANVAS \
 143                           QM_EXPORT_DNS \
 144                           QM_EXPORT_DOM \
 145                           QM_EXPORT_FTP \
 146                           QM_EXPORT_HTTP \
 147                           QM_EXPORT_ICONVIEW \
 148                           QM_EXPORT_NETWORK \
 149                           QM_EXPORT_OPENGL \
 150                           QM_EXPORT_SQL \
 151                           QM_EXPORT_TABLE \
 152                           QM_EXPORT_WORKSPACE \
 153                           QM_EXPORT_XML \
 154                           QT_ASCII_CAST_WARN \
 155                           QT_ASCII_CAST_WARN_CONSTRUCTOR \
 156                           QT_BEGIN_HEADER \
 157                           QT_DESIGNER_STATIC \
 158                           QT_END_HEADER \
 159                           QT_FASTCALL \
 160                           QT_WIDGET_PLUGIN_EXPORT \
 161                           Q_COMPAT_EXPORT \
 162                           Q_CORE_EXPORT \
 163                           Q_EXPLICIT \
 164                           Q_EXPORT \
 165                           Q_EXPORT_CODECS_CN \
 166                           Q_EXPORT_CODECS_JP \
 167                           Q_EXPORT_CODECS_KR \
 168                           Q_EXPORT_PLUGIN \
 169                           Q_GFX_INLINE \
 170                           Q_GUI_EXPORT \
 171                           Q_GUI_EXPORT_INLINE \
 172                           Q_GUI_EXPORT_STYLE_CDE \
 173                           Q_GUI_EXPORT_STYLE_COMPACT \
 174                           Q_GUI_EXPORT_STYLE_MAC \
 175                           Q_GUI_EXPORT_STYLE_MOTIF \
 176                           Q_GUI_EXPORT_STYLE_MOTIFPLUS \
 177                           Q_GUI_EXPORT_STYLE_PLATINUM \
 178                           Q_GUI_EXPORT_STYLE_POCKETPC \
 179                           Q_GUI_EXPORT_STYLE_SGI \
 180                           Q_GUI_EXPORT_STYLE_WINDOWS \
 181                           Q_GUI_EXPORT_STYLE_WINDOWSXP \
 182                           QHELP_EXPORT \
 183                           Q_INLINE_TEMPLATE \
 184                           Q_INTERNAL_WIN_NO_THROW \
 185                           Q_NETWORK_EXPORT \
 186                           Q_OPENGL_EXPORT \
 187                           Q_OUTOFLINE_TEMPLATE \
 188                           Q_SQL_EXPORT \
 189                           Q_SVG_EXPORT \
 190                           Q_SCRIPT_EXPORT \
 191                           Q_TESTLIB_EXPORT \
 192                           Q_TYPENAME \
 193                           Q_XML_EXPORT \
 194                           Q_XMLSTREAM_EXPORT \
 195                           Q_XMLPATTERNS_EXPORT \
 196                           QDBUS_EXPORT \
 197                           QT_BEGIN_NAMESPACE \
 198                           QT_BEGIN_INCLUDE_NAMESPACE \
 199                           QT_END_NAMESPACE \
 200                           QT_END_INCLUDE_NAMESPACE \
 201                           PHONON_EXPORT \
 202                           EXTENSIONSYSTEM_EXPORT
 203 Cpp.ignoredirectives    = Q_DECLARE_HANDLE \
 204                           Q_DECLARE_INTERFACE \
 205                           Q_DECLARE_METATYPE \
 206                           Q_DECLARE_OPERATORS_FOR_FLAGS \
 207                           Q_DECLARE_PRIVATE \
 208                           Q_DECLARE_PUBLIC \
 209                           Q_DECLARE_SHARED \
 210                           Q_DECLARE_TR_FUNCTIONS \
 211                           Q_DECLARE_TYPEINFO \
 212                           Q_DISABLE_COPY \
 213                           QT_FORWARD_DECLARE_CLASS \
 214                           Q_DUMMY_COMPARISON_OPERATOR \
 215                           Q_ENUMS \
 216                           Q_FLAGS \
 217                           Q_INTERFACES \
 218                           __attribute__ \
 219                           K_DECLARE_PRIVATE \
 220                           PHONON_OBJECT \
 221                           PHONON_HEIR
 222
 223 creator = true