Skip to content
This repository

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

..
Octocat-spinner-32 CocktailDoc.hx
Octocat-spinner-32 README.txt
Octocat-spinner-32 buildCocktail_doc.hxml
README.txt
/*
 * 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/
*/

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.
Something went wrong with that request. Please try again.