Home | History | Annotate | Download | only in docs
      1 # Run qdoc from the directory that contains this file.
      2 
      3 project     = qtwebkit
      4 description = "Qt WebKit API Documentation"
      5 
      6 headerdirs = $SRCDIR/WebKit/qt/Api $SRCDIR/WebKit/qt/declarative
      7 sourcedirs = $SRCDIR/WebKit/qt/Api $SRCDIR/WebKit/qt/docs $SRCDIR/Source/JavaScriptCore/qt/api $SRCDIR/WebKit/qt/declarative
      8 outputdir = $OUTPUT_DIR/doc/html
      9 outputformats = HTML
     10 sources.fileextensions  = "*.cpp *.doc *.qdoc *.h"
     11 exampledirs = $SRCDIR/WebKit/qt/docs
     12 imagedirs = $SRCDIR/WebKit/qt/docs
     13 
     14 indexes = $QTDIR/doc/html/qt.index
     15 
     16 # macros.qdocconf
     17 
     18 macro.aring.HTML        = "å"
     19 macro.Auml.HTML         = "Ä"
     20 macro.author            = "\\bold{Author:}"
     21 macro.br.HTML           = "<br />"
     22 macro.BR.HTML           = "<br />"
     23 macro.aacute.HTML       = "&aacute;"
     24 macro.eacute.HTML       = "&eacute;"
     25 macro.iacute.HTML       = "&iacute;"
     26 macro.gui               = "\\bold"
     27 macro.hr.HTML           = "<hr />"
     28 macro.key               = "\\bold"
     29 macro.menu              = "\\bold"
     30 macro.note              = "\\bold{Note:}"
     31 macro.oslash.HTML       = "&oslash;"
     32 macro.ouml.HTML         = "&ouml;"
     33 macro.QA                = "\\e{Qt Assistant}"
     34 macro.QD                = "\\e{Qt Designer}"
     35 macro.QL                = "\\e{Qt Linguist}"
     36 macro.param             = "\\e"
     37 macro.raisedaster.HTML  = "<sup>*</sup>"
     38 macro.reg.HTML          = "<sup>&reg;</sup>"
     39 macro.return            = "Returns"
     40 macro.starslash         = "\\c{*/}"
     41 macro.uuml.HTML         = "&uuml;"
     42 macro.mdash.HTML        = "&mdash;"
     43 
     44 # compat.qdocconf
     45 
     46 alias.i				= e
     47 alias.include			= input
     48 
     49 macro.0                         = "\\\\0"
     50 macro.b                         = "\\\\b"
     51 macro.n                         = "\\\\n"
     52 macro.r                         = "\\\\r"
     53 macro.i                         = "\\o"
     54 macro.i11                       = "\\o{1,1}"
     55 macro.i12                       = "\\o{1,2}"
     56 macro.i13                       = "\\o{1,3}"
     57 macro.i14                       = "\\o{1,4}"
     58 macro.i15                       = "\\o{1,5}"
     59 macro.i16                       = "\\o{1,6}"
     60 macro.i17                       = "\\o{1,7}"
     61 macro.i18                       = "\\o{1,8}"
     62 macro.i19                       = "\\o{1,9}"
     63 macro.i21                       = "\\o{2,1}"
     64 macro.i31                       = "\\o{3,1}"
     65 macro.i41                       = "\\o{4,1}"
     66 macro.i51                       = "\\o{5,1}"
     67 macro.i61                       = "\\o{6,1}"
     68 macro.i71                       = "\\o{7,1}"
     69 macro.i81                       = "\\o{8,1}"
     70 macro.i91                       = "\\o{9,1}"
     71 macro.img                       = "\\image"
     72 macro.endquote                  = "\\endquotation"
     73 
     74 spurious			= "Missing comma in .*" \
     75 				  "Missing pattern .*"
     76 
     77 # Doxygen compatibility commands
     78 
     79 macro.see                       = "\\sa"
     80 macro.function                  = "\\fn"
     81 
     82 # qt-cpp-ignore.qdocconf
     83 
     84 Cpp.ignoretokens        = QAXFACTORY_EXPORT \
     85                           QDESIGNER_COMPONENTS_LIBRARY \
     86                           QDESIGNER_EXTENSION_LIBRARY \
     87                           QDESIGNER_SDK_LIBRARY \
     88                           QDESIGNER_SHARED_LIBRARY \
     89                           QDESIGNER_UILIB_LIBRARY \
     90                           QM_EXPORT_CANVAS \
     91                           QM_EXPORT_DNS \
     92                           QM_EXPORT_DOM \
     93                           QM_EXPORT_FTP \
     94                           QM_EXPORT_HTTP \
     95                           QM_EXPORT_ICONVIEW \
     96                           QM_EXPORT_NETWORK \
     97                           QM_EXPORT_OPENGL \
     98                           QM_EXPORT_SQL \
     99                           QM_EXPORT_TABLE \
    100                           QM_EXPORT_WORKSPACE \
    101                           QM_EXPORT_XML \
    102                           QT_ASCII_CAST_WARN \
    103                           QT_ASCII_CAST_WARN_CONSTRUCTOR \
    104                           QT_BEGIN_HEADER \
    105                           QT_DESIGNER_STATIC \
    106                           QT_END_HEADER \
    107                           QT_FASTCALL \
    108                           QT_WIDGET_PLUGIN_EXPORT \
    109                           Q_COMPAT_EXPORT \
    110                           Q_CORE_EXPORT \
    111                           Q_EXPLICIT \
    112                           Q_EXPORT \
    113                           Q_EXPORT_CODECS_CN \
    114                           Q_EXPORT_CODECS_JP \
    115                           Q_EXPORT_CODECS_KR \
    116                           Q_EXPORT_PLUGIN \
    117                           Q_GFX_INLINE \
    118                           Q_GUI_EXPORT \
    119                           Q_GUI_EXPORT_INLINE \
    120                           Q_GUI_EXPORT_STYLE_CDE \
    121                           Q_GUI_EXPORT_STYLE_COMPACT \
    122                           Q_GUI_EXPORT_STYLE_MAC \
    123                           Q_GUI_EXPORT_STYLE_MOTIF \
    124                           Q_GUI_EXPORT_STYLE_MOTIFPLUS \
    125                           Q_GUI_EXPORT_STYLE_PLATINUM \
    126                           Q_GUI_EXPORT_STYLE_POCKETPC \
    127                           Q_GUI_EXPORT_STYLE_SGI \
    128                           Q_GUI_EXPORT_STYLE_WINDOWS \
    129                           Q_GUI_EXPORT_STYLE_WINDOWSXP \
    130                           QHELP_EXPORT \
    131                           Q_INLINE_TEMPLATE \
    132                           Q_INTERNAL_WIN_NO_THROW \
    133                           Q_NETWORK_EXPORT \
    134                           Q_OPENGL_EXPORT \
    135                           Q_OUTOFLINE_TEMPLATE \
    136                           Q_SQL_EXPORT \
    137                           Q_SVG_EXPORT \
    138                           Q_SCRIPT_EXPORT \
    139                           Q_TESTLIB_EXPORT \
    140                           Q_TYPENAME \
    141                           Q_XML_EXPORT \
    142                           Q_XMLSTREAM_EXPORT \
    143                           Q_XMLPATTERNS_EXPORT \
    144                           QDBUS_EXPORT \
    145                           QT_BEGIN_NAMESPACE \
    146                           QT_BEGIN_INCLUDE_NAMESPACE \
    147                           QT_END_NAMESPACE \
    148                           QT_END_INCLUDE_NAMESPACE \
    149                           PHONON_EXPORT \
    150                           EXTENSIONSYSTEM_EXPORT \
    151                           QWEBKIT_EXPORT
    152 Cpp.ignoredirectives    = Q_DECLARE_HANDLE \
    153                           Q_DECLARE_INTERFACE \
    154                           Q_DECLARE_METATYPE \
    155                           Q_DECLARE_OPERATORS_FOR_FLAGS \
    156                           Q_DECLARE_PRIVATE \
    157                           Q_DECLARE_PUBLIC \
    158                           Q_DECLARE_SHARED \
    159                           Q_DECLARE_TR_FUNCTIONS \
    160                           Q_DECLARE_TYPEINFO \
    161                           Q_DISABLE_COPY \
    162                           QT_FORWARD_DECLARE_CLASS \
    163                           Q_DUMMY_COMPARISON_OPERATOR \
    164                           Q_ENUMS \
    165                           Q_FLAGS \
    166                           Q_INTERFACES \
    167                           __attribute__ \
    168                           K_DECLARE_PRIVATE \
    169                           PHONON_OBJECT \
    170                           PHONON_HEIR
    171 
    172 
    173 
    174 HTML.style              = "" \
    175                           "h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }"\
    176                           "a:link { color: #004faf; text-decoration: none }"\
    177                           "a:visited { color: #672967; text-decoration: none }"\
    178                           "td.postheader { font-family: sans-serif }"\
    179                           "tr.address { font-family: sans-serif }"\
    180                           "body { background: #ffffff; color: black }"\
    181                           "table tr.odd { background: #f0f0f0; color: black; }"\
    182                           "table tr.even { background: #e4e4e4; color: black; }"\
    183                           "table.annotated th { padding: 3px; text-align: left }"\
    184                           "table.annotated td { padding: 3px; } "\
    185                           "table tr pre { padding-top: none; padding-bottom: none; padding-left: none; padding-right: none; border: none; background: none }"\
    186                           "tr.qt-style { background: #a2c511; color: black }"\
    187                           "body pre { padding: 0.2em; border: #e7e7e7 1px solid; background: #f1f1f1; color: black }"\
    188                           "span.preprocessor, span.preprocessor a { color: darkblue; }"\
    189                           "span.comment { color: darkred; font-style: italic }"\
    190                           "span.string,span.char { color: darkgreen; }"\
    191                           ".title { text-align: center }"\
    192                           ".subtitle { font-size: 0.8em }"\
    193                           ".small-subtitle { font-size: 0.65em }"
    194 
    195 HTML.postheader         = ""
    196 
    197 HTML.footer             = ""
    198