Liberi Developer Guide: Documentation

From EQUIS Lab Wiki

Jump to: navigation, search

API

The annotated class list for Liberi can be found on our server at http://equis.cs.queensu.ca/~equis/liberi/api. These docs list the components and classes used in the Unity project, and do not include the documentation of the LiberiWorld files (the WorldServer and ServerPool code).

liberi_docs_image.png
Fancy graphic showcasing the API.

Generating the Docs

The HTML documentation is generated from the main Liberi branch source code using Doxygen. When generating docs, you should target the Assets/Scripts folder of the Unity project as the directory containing the source code to analyse. After regenerating the docs, the branch should be committed with the updated HTML output, and the new HTML should be publish to the lab web server.

Comments in the code should use XML Documentation format to reliably generate nice HTML output.

Retrieved from "http://equis.cs.queensu.ca/wiki/index.php/Liberi_Developer_Guide:_Documentation"