1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
|
{% msg %}----- Start generating HTML output for {{ config.PROJECT_NAME }} from template ----{% endmsg %}
{# ---- copy fixed resources to the output ----- #}
{% resource 'doxygen.css' %}
{% resource 'tabs.css' %}
{% resource 'jquery.js' %}
{% resource 'dynsections.js %}
{% resource 'tab_a.lum' %}
{% resource 'tab_b.lum' %}
{% resource 'tab_h.lum' %}
{% resource 'tab_s.lum' %}
{% resource 'tab_h.lum' %}
{% resource 'bc_s.luma' %}
{% resource 'doxygen.luma' %}
{% resource 'closed.luma' %}
{% resource 'open.luma' %}
{% resource 'bdwn.luma' %}
{% resource 'sync_on.luma' %}
{% resource 'sync_off.luma' %}
{# navigation #}
{% resource 'nav_f.lum' %}
{% resource 'nav_g.png' %}
{% resource 'nav_h.lum' %}
{% resource 'navtree.css' %}
{% resource 'navtree.js' %}
{% resource 'resize.js' %}
{% resource 'menu.js' %}
{% resource 'doc.luma' %}
{% resource 'folderopen.luma' %}
{% resource 'folderclosed.luma' %}
{% resource 'splitbar.lum' %}
{# general search resources #}
{% resource 'search_l.png' as 'search/search_l.png' %}
{% resource 'search_m.png' as 'search/search_m.png' %}
{% resource 'search_r.png' as 'search/search_r.png' %}
{% if config.DISABLE_INDEX %}
{% resource 'search_noidx.css' as 'search/search.css' %}
{% else %}
{% resource 'search.css' as 'search/search.css' %}
{% endif %}
{% if config.SERVER_BASED_SEARCH %}
{# server side search resources #}
{% resource 'mag.svg' as 'search/mag.svg' %}
{% resource 'extsearch.js as 'search/search.js' %}
{% resource 'search_functions.php' as 'search/search_functions.php' %}
{% resource 'search_opensearch.php' as 'search/search_opensearch.php' %}
{% else %}
{# client side search resources #}
{% resource 'mag_sel.svg' as 'search/mag_sel.svg' %}
{% resource 'close.svg' as 'search/close.svg' %}
{% resource 'search.js' as 'search/search.js' %}
{% endif %}
{# interactive SVGs #}
{% resource 'svgpan.js' %}
{# -------------------------------------------------- #}
{# global constants #}
{% set maxItemsForFlatList=30 %}
{% set maxItemsForMultiPageList=200 %}
{# global variable #}
{% set page_postfix='' %}
{# open the global navigation index #}
{% indexentry nav name=tr.mainPage file='index' anchor='' isReference=False %}
{% opensubindex nav %}
{# ----------- HTML DOCUMENTATION PAGES ------------ #}
{# write main page documentation #}
{% with page=mainPage compound=mainPage isMainPage=True %}
{% create mainPage.fileName|append:config.HTML_FILE_EXTENSION from 'htmlpage.tpl' %}
{% endwith %}
{# write namespace documentation pages #}
{% for compound in namespaceList %}
{% with page=compound %}
{% create compound.fileName|append:config.HTML_FILE_EXTENSION from 'htmlnamespace.tpl' %}
{% endwith %}
{% endfor %}
{# write class documentation pages #}
{% for compound in classList %}
{% with page=compound %}
{% create compound.fileName|append:config.HTML_FILE_EXTENSION from 'htmlclass.tpl' %}
{% if compound.allMembersList and not config.OPTIMIZE_OUTPUT_FOR_C %}
{% create compound.allMembersFileName|append:config.HTML_FILE_EXTENSION from 'htmlallmembers.tpl' %}
{% endif %}
{% endwith %}
{% endfor %}
{# write the file sources #}
{% for compound in fileList %}
{% with page=compound %}
{# TODO: to deal with clang optimization, we need to write the sources in a different order! #}
{% if compound.hasSourceFile %}
{% create compound.sourceFileName|append:config.HTML_FILE_EXTENSION from 'htmlsource.tpl' %}
{% endif %}
{% endwith %}
{% endfor %}
{# write file documentation pages #}
{% for compound in fileList %}
{% with page=compound %}
{% create compound.fileName|append:config.HTML_FILE_EXTENSION from 'htmlfile.tpl' %}
{% endwith %}
{% endfor %}
{# write related page documentation #}
{% for compound in pageList %}
{% with page=compound isMainPage=False %}
{% create compound.fileName|append:config.HTML_FILE_EXTENSION from 'htmlpage.tpl' %}
{% endwith %}
{% endfor %}
{# write module documentation #}
{% for compound in moduleList %}
{% with page=compound %}
{% create compound.fileName|append:config.HTML_FILE_EXTENSION from 'htmlmodule.tpl' %}
{% endwith %}
{% endfor %}
{# write example documentation #}
{% for compound in exampleList %}
{% with page=compound %}
{% create compound.fileName|append:config.HTML_FILE_EXTENSION from 'htmlexample.tpl' %}
{% endwith %}
{% endfor %}
{# ----------- INDEXES ------------ #}
{# --- related pages --- #}
{% if pageTree.tree %}
{% with page=pageTree %}
{% create pageTree.fileName|append:config.HTML_FILE_EXTENSION from 'htmlpages.tpl' %}
{% endwith %}
{% endif %}
{# ---- examples --- #}
{% if exampleTree.tree %}
{% with page=exampleTree %}
{% create exampleTree.fileName|append:config.HTML_FILE_EXTENSION from 'htmlexamples.tpl' %}
{% endwith %}
{% endif %}
{# --- modules --- #}
{% if moduleTree.tree %}
{% with page=moduleTree %}
{% create moduleTree.fileName|append:config.HTML_FILE_EXTENSION from 'htmlmodules.tpl' %}
{% endwith %}
{% endif %}
{# --- namespaces --- #}
{% if namespaceList %}
{% indexentry nav name=tr.namespaces file='' anchor='' isReference=False %}
{% opensubindex nav %}
{% if namespaceTree.tree %}
{% with page=namespaceTree %}
{% create namespaceTree.fileName|append:config.HTML_FILE_EXTENSION from 'htmlnamespaces.tpl' %}
{% endwith %}
{% endif %}
{# write symbol indices for namespace members #}
{% if namespaceMembersIndex.all %}
{% with page=namespaceMembersIndex scope='namespace' template='htmlnsmembers.tpl' %}
{% indexentry nav name=tr.namespaceMembers file=page.fileName anchor='' isReference=False %}
{% include 'htmlmembersindex.tpl' %}
{% endwith %}
{% endif %}
{% closesubindex nav %}
{% endif %}
{# --- classes --- #}
{% if classList %}
{% indexentry nav name=tr.classes file='' anchor='' isReference=False %}
{% opensubindex nav %}
{# write the annotated class list #}
{% if classTree.tree %}
{% with page=classTree %}
{% create classTree.fileName|append:config.HTML_FILE_EXTENSION from 'htmlannotated.tpl' %}
{% endwith %}
{% endif %}
{# write class index #}
{% if classIndex.list %}
{% with page=classIndex %}
{% create classIndex.fileName|append:config.HTML_FILE_EXTENSION from 'htmlclasses.tpl' %}
{% endwith %}
{% endif %}
{# write the class inheritance hierarchy #}
{% if classHierarchy.tree %}
{% with page=classHierarchy %}
{% create classHierarchy.fileName|append:config.HTML_FILE_EXTENSION from 'htmlhierarchy.tpl' %}
{% if config.HAVE_DOT and config.GRAPHICAL_HIERARCHY %}
{% with fileName='inherits' %}
{% create fileName|append:config.HTML_FILE_EXTENSION from 'htmlgraphhierarchy.tpl' %}
{% endwith %}
{% endif %}
{% endwith %}
{% endif %}
{# write symbol indices for class members #}
{% if classMembersIndex.all %}
{% with page=classMembersIndex scope='class' template='htmlclmembers.tpl' %}
{% indexentry nav name=tr.classMembers file=page.fileName anchor='' isReference=False %}
{% include 'htmlmembersindex.tpl' %}
{% endwith %}
{% endif %}
{% closesubindex nav %}
{% endif %}
{# --- files --- #}
{% if fileList %}
{% indexentry nav name=tr.files file='' anchor='' isReference=False %}
{% opensubindex nav %}
{# write the directory/file hierarchy #}
{% if fileTree.tree %}
{% with page=fileTree %}
{% create fileTree.fileName|append:config.HTML_FILE_EXTENSION from 'htmlfiles.tpl' %}
{% endwith %}
{% endif %}
{# write symbol indices for global namespace #}
{% if globalsIndex.all %}
{% with page=globalsIndex scope='file' template='htmlflmembers.tpl' %}
{% indexentry nav name=tr.fileMembers file=page.fileName anchor='' isReference=False %}
{% include 'htmlmembersindex.tpl' %}
{% endwith %}
{% endif %}
{% closesubindex nav %}
{% endif %}
{# write directory documentation pages #}
{% for compound in dirList %}
{% with page=compound %}
{% create compound.fileName|append:config.HTML_FILE_EXTENSION from 'htmldir.tpl' %}
{% endwith %}
{% endfor %}
{# close the global navigation index #}
{% closesubindex nav %}
{# write search data #}
{% if config.SEARCHENGINE and not config.SERVER_BASED_SEARCH %}
{% create 'search/searchdata.js' from 'htmljssearchdata.tpl' %}
{% for idx in searchIndices %}
{% for si in idx.symbolIndices %}
{% with baseName=si.name|append:'_'|append:forloop.counter0 %}
{% create baseName|prepend:'search/'|append:config.HTML_FILE_EXTENSION from 'htmlsearchresult.tpl' %}
{% create baseName|prepend:'search/'|append:'.js' from 'htmljssearchindex.tpl' %}
{% endwith %}
{% endfor %}
{% endfor %}
{% endif %}
{# write html help index #}
{% if config.GENERATE_HTMLHELP %}
{% encoding config.CHM_INDEX_ENCODING|default:'CP1250' %}
{% create 'index.hhp' from 'htmlhelpindexhhp.tpl' %}
{% create 'index.hhc' from 'htmlhelpindexhhc.tpl' %}
{% endencoding %}
{% endif %}
{# write the navigation tree data #}
{% if config.GENERATE_TREEVIEW %}
{% create 'navtreedata.js' from 'htmljsnavtree.tpl' %}
{% endif %}
{# write menu data #}
{% if not config.DISABLE_INDEX %}
{% create 'menudata.js' from 'htmljsmenudata.tpl' %}
{% endif %}
{% msg %}----- End generating HTML output for {{ config.PROJECT_NAME }} from template ----{% endmsg %}
|