Generating documentation

CBA's documentation is automatically generated from the source code comments. Function documentation will be visible in-game within the functions browser (call BIS_fnc_help to see it). Both macro and function documentation will be generated as browsable HTML.

Installation required

  1. Install Ruby (Recommendation: Use the 1.8.6 windows installer, then manually copy over it with the 1.8.7 binary package).
  2. Install ActivePerl (Other implementations of Perl should be fine, but CBA has only been tested with ActivePerl).
  3. Install NaturalDocs.
  4. Ensure that you have a correct path to your version of CBA before running anything (i.e. cba directory must be in an x directory).

Generating the documentation

  1. Run x\cba\utils\make_functions_config.bat
  2. Run x\cba\utils\make_docs.bat

Documentation will be generated at docs\cba_functions_library\, which will also be packaged as docs\cba_functions_library.7z.