/doc/README.txt

http://github.com/silexlabs/Cocktail · Plain Text · 30 lines · 25 code · 5 blank · 0 comment · 0 complexity · ac5037de960bebcc813d895968e995e6 MD5 · raw file 

    

  1. <<<<<<< HEAD
    2. 

  2. =======
    3. 

  3. /*
    4. 

  4.  * Cocktail, HTML rendering engine
    5. 

  5.  * http://haxe.org/com/libs/cocktail
    6. 

  6.  *
    7. 

  7.  * Copyright (c) Silex Labs
    8. 

  8.  * Cocktail is available under the MIT license
    9. 

  9.  * http://www.silexlabs.org/labs/cocktail-licensing/
    10. 

  10. */
    11. 

  11. 

  12. >>>>>>> 56a95fa34cb013c2c632910e3904c4fc53bd0245
    13. 

  13. GENERATING THE DOC
    14. 

  14. -----------------------
    15. 

  15. 

  16. The doc is generated using the Haxe lib chxdoc.
    17. 

  17. It is use instead of haxedoc for the following feature :
    18. 

  18. - support of JavaDoc tag (like @param)
    19. 

  19. - easier styling with external style sheet
    20. 

  20. - styled generated doc out-of-the-box
    21. 

  21. 

  22. To compile the doc, you must install chxdoc with the following command lines : 
    23. 

  23. 

  24. haxelib install chxdoc
    25. 

  25. haxelib run chxdoc install [optional path]
    26. 

  26. 

  27. The first line install the chxdoc library in your haxe install folder,
    28. 

  28. the second one compile chxdoc into an executable in the "optionnal path" directory.
    29. 

  29. It is recommended that the "optionnal path" points to the same directory as this
    30. 

  30. README because the .hxml generating the doc assumes that the executable is here.
    31.