5 C API

This chapter contains a description of all modules and a list of all documented C functions in the program. It contains many references and is self-generated from C comments using gdoc by Simon Josefsson.

In order to reduce the number of pages of printed output, this complete reference is, by default, disabled in printable versions of the documentation (PostScript, PDF). This is both to make the manual more readable and to avoid wasting paper. Think about the environment.

It is however available in the HTML version of the documentation, which you can read online on http://www.gnu.org/software/liquidwar6/manual/html_node/.

Additionnally, the following adresses contain various view on the source code, giving informations on all the internal and public C interfaces:

• http://www.ufoot.org/liquidwar/v6/doc/coverage/: the lcov output when running ./liquidwar6 --test. It shows what functions are actually tested, and how many times they are called.
• http://www.ufoot.org/liquidwar/v6/doc/global/: the GNU global output gives complete cross-references, macros, headers, contants declaration. It’s a very good place to start browsing the code.
• http://www.ufoot.org/liquidwar/v6/doc/cyclo/: the pmccabe output shows the cyclomatic complexity of functions. It enables the programmer to spots the “ugly” and dangerous parts of the program.
• http://www.ufoot.org/liquidwar/v6/doc/doxygen/: the Doxygen documentation gives an interactive access to the code, the structures and functions, and their dependencies.