API Reference

Overview

This section provides automatically generated API documentation for WhiskerToolbox classes, functions, and data structures. The documentation is generated from the Doxygen comments in the source code.

Browse the API Documentation

The complete API reference is available through the Doxygen-generated documentation:

Open API Documentation

Key Sections

The API documentation includes:

  • Classes: Documentation for all C++ classes including DataManager, various widget classes, and data processing classes
  • Namespaces: Organized documentation by namespace
  • Files: Documentation organized by source file location
  • Functions: All public functions and methods with parameter descriptions

Building the API Documentation

To regenerate the API documentation locally:

cd /path/to/WhiskerToolbox
doxygen Doxyfile

This will regenerate the documentation in the docs/api/html/ directory.