> haxedoc doc.xml;neko
If the generated index.html page is opened in a web browser, a list of links will be presented. The
aesthetic of the file is a little bit raw and this is because no template has been used to produce the
documentation. To create a more appealing document, copy the file template.xml that is included in
the directory std/tools/haxedoc of the haXe installation in the same folder of the XML files. This
template is the same used for the API documentation on the site www.haxe.org . Otherwise, it is possible
to use this template as a reference and to change its characteristics to fit the project needs. Figures 6 - 2
and 6 - 3 show the index page and the documentation of the enum described in the previous example with
a custom template applied.
Figure 6 - 2
169
Chapter 6: Organizing Your Code
Figure 6 - 3
Online Documentation
The online version is used when the pages are to be accessed through an Internet connection. The pages
are not statically generated but created on request. To use this tool, copy (a symlink is a better option if
using a non - windows operating system) the file haxedoc.
Pages:
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337