API Reference

Complete class and method documentation generated from inline YARD comments.

Online Documentation

Official API documentation is hosted on RubyDoc.info:

🔗 https://rubydoc.info/gems/musa-dsl

This documentation is automatically generated and updated with each gem release.

Key Modules

Foundation

• Musa::Extension - Ruby refinements and metaprogramming
• Musa::Logger - Structured logging

Temporal & Scheduling

• Musa::Sequencer - Event scheduling engine
• Musa::Transport - Playback lifecycle
• Musa::Clock - Timing sources

Notation & Parsing

• Musa::Neumas - Musical notation
• Musa::Neumalang - Notation parser

Generation & Transformation

• Musa::Series - Sequence generators
• Musa::Generative - Algorithmic composition
• Musa::Matrix - Gesture conversion

Output & Communication

• Musa::Transcription - Event transformation
• Musa::MusicXML::Builder - Score generation
• Musa::MIDIVoices - Voice management
• Musa::MIDIRecorder - MIDI recording

Musical Knowledge

• Musa::Scales - Scale systems
• Musa::Chords - Chord structures
• Musa::Datasets - Data structures

Development

• Musa::REPL - Live coding server

Generating Documentation Locally

If you want to generate the API documentation locally:

Install YARD

gem install yard

Generate Documentation

cd /path/to/musa-dsl
yard doc

This creates documentation in the doc/ directory (not versioned in git).

Browse Documentation

yard server

Then open http://localhost:8808 in your browser.

Documentation Coverage

Check which code is documented:

yard stats --list-undoc

See Also

• Conceptual Documentation: subsystems/ - Guides and tutorials for each subsystem
• Examples: examples/ - Runnable code examples
• Main Documentation: README.md - Documentation hub