Introduction

Welcome to CWB

This documentation describes the software classes and functions that makes up the CWB software system as well as their application programming interface (API). This is not an introduction of CWB, for this please refer to the CWB Pipeline Documentation. This documentation is generated directly from the source code using Doxygen and in principle is kept up to date. The version of CWB corresponding to this documentation is indicated at the page heading. You may also find in reference documentation page pointers to reference manuals for other CWB versions.

How to use this reference documentation

The User’s Classes in the top bar provides the user API, mainly the list of main Users' classes organized by module or functionality. The full list of classes, both for the public API and for the implementation details are available under the All Classes tab. A classification of classes based on their C++ namespace can be found under the Namespace tab. The fully indexed list of all source code is available under the tab Files.

CWB provides other types of documentation:

• A general Users Guide is provided for a more in depth explanation of concepts and functionality available in the CWB system.
• A rich set of CWB tutorials and code examples are offered to developers to exercise specific functionality.
• A rich set of HowTo's is also present to discuss issues commonly faced by CWB users.

Caveat

We have moved recently to generate the documentation with Doxygen. To achieve this the comments in the source code needed to be formatted and written specifically for Doxygen to generated proper documentation. If you find missing documentation or inaccuracies please report them to our bug tracker. Detailed instructions on how to submit a bug can be found here.