Library documentation

From MCRL2

The mCRL2 Library Tutorial contains tutorials for individual libraries, and general information intended for mCRL2 developers. Other sources of documentation can be found in the table below.

ATerm++	User manual	Reference manual
Core	User manual	Reference manual
Data	User manual	Reference manual	Other documents
LPS	User manual	Reference manual	Other documents
LTS	User manual	Reference manual
PBES	User manual	Reference manual	Other documents
Process	User manual	Reference manual	Other documents
TIPi	User manual]	Reference manual
Trace	User manual	Reference manual
Utilities	User manual	Reference manual

• The user manual describes the library's structure and use.
• The reference manual contains a doxygen reference of the library's interfaces.
• The other documents contains algorithm specifications.

Notes for developers

All of the documentation is automatically generated daily. There are three different types of documentation, summarized below.

Quickbook documentation

Library tutorials are written in Quickbook format. Quickbook files (.qbk) are located in the /doc sub-folders of the libraries. To generate documentation for a single library, use the command bjam html in the doc directory. To generate all of the documentation at once, use the command bjam html in the MCRL2_ROOT/doc directory. To install Quickbook, follow the instructions in Quickbook.

Doxygen documentation

Reference documentation consists of Doxygen comments in the source code.

LaTeX documentation

Algorithm specifications are written in LaTeX. Files that have the pattern libraries/LIBRARY/doc/tex/wiki-FILE.tex are automatically converted to pdf format.