ElectroTime

Flutter/Dart API Documentation

Complete API reference for the Latency Recorder GUI application

Important: Download Required

The Flutter/Dart documentation uses advanced features like search and cross-references that do not work when served from GitHub Pages. You must download the documentation and open it locally on your computer for it to function properly.

Download Documentation

Download the complete Flutter/Dart API documentation package

Size: ~5MB • Contains all API documentation and search index

How to Use the Documentation

1

Download the Documentation

Click the "Download Documentation (ZIP)" button above to download the complete Flutter/Dart API documentation package to your computer.

2

Extract the ZIP File

Extract the downloaded ZIP file to a folder on your computer. This will create aflutter-dart-docs folder containing all the documentation files.

3

Open index.html

Navigate to the extracted folder and double-click on index.htmlto open the documentation in your web browser. All features including search will now work properly.

4

Navigate Libraries

Once opened locally, use the sidebar to browse through the different libraries:

  • about - About page functionality
  • device - Device connection and control
  • home - Main application interface
  • main - Application entry point
  • ports - Serial port management
  • recordbutton - Recording UI components

Generate Fresh Documentation

To generate the latest documentation from source:

cd gui
dart doc
# Documentation will be generated in doc/api/

Documentation Features

Full API reference for all classes and methods
Interactive search functionality
Cross-referenced navigation
Source code links
Inheritance hierarchies
Light/dark theme support