📚 API Documentation
Complete API reference documentation for all components of the Latency Recorder project.
🦀 Rust Firmware API
Low-level firmware documentation for the Arduino-based latency recorder.
View Hardware Development Guide →🎯 Flutter GUI API
Complete API reference for the cross-platform desktop application.
View GUI Development Guide →🔧 Generating Documentation
The API documentation is auto-generated from source code comments. To regenerate:
# From the project root
./generate-docs.sh
# Or manually:
# Rust docs
cd firmware/latreclib && cargo doc --no-deps
# Flutter docs
cd gui && dart doc📝 Documentation Standards
Rust Documentation
Use triple-slash comments (///) for public items. Include examples using```rust code blocks within doc comments.
Flutter Documentation
Use triple-slash comments (///) for public APIs. FollowEffective Dart documentation guidelines.