Prev | Current Page 324 | Next

L. McColl-Sylvester and F. Ponticelli

"Professional haXe and Neko"

Note that the documentation will contain information about every
type imported in the application and those that are part of the standard libraries or the haxelib.
The haxedoc command accepts the following syntax:
haxedoc file.xml;platform -f ClassName
Where file.xml is the XML generated by the haXe compiler, platform is an indication that this file
refers to a specific platform (multiple platforms can be used) and - f (filter) is used to produce
documentation for only the specified type (the switch can be repeated to include more types). Both
file.xml and the - f switch can repeated more than once with different values. In the first case,
documentations from different platforms will be merged in a single structure to avoid duplication of
information; repeating the filter switch permits you to produce documentation for multiple files.
168
Part I: The Core Language
Executing the following command in the directory containing the doc.xml produces a set of HTML files
that can be explored using a standard browser.


Pages:
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336