/doc/README.txt
http://github.com/silexlabs/Cocktail · Plain Text · 30 lines · 25 code · 5 blank · 0 comment · 0 complexity · ac5037de960bebcc813d895968e995e6 MD5 · raw file
- <<<<<<< HEAD
- =======
- /*
- * Cocktail, HTML rendering engine
- * http://haxe.org/com/libs/cocktail
- *
- * Copyright (c) Silex Labs
- * Cocktail is available under the MIT license
- * http://www.silexlabs.org/labs/cocktail-licensing/
- */
- >>>>>>> 56a95fa34cb013c2c632910e3904c4fc53bd0245
- GENERATING THE DOC
- -----------------------
- The doc is generated using the Haxe lib chxdoc.
- It is use instead of haxedoc for the following feature :
- - support of JavaDoc tag (like @param)
- - easier styling with external style sheet
- - styled generated doc out-of-the-box
- To compile the doc, you must install chxdoc with the following command lines :
- haxelib install chxdoc
- haxelib run chxdoc install [optional path]
- The first line install the chxdoc library in your haxe install folder,
- the second one compile chxdoc into an executable in the "optionnal path" directory.
- It is recommended that the "optionnal path" points to the same directory as this
- README because the .hxml generating the doc assumes that the executable is here.