From 5120930919bfe88d697d56fbe93f8b4ad56f0362 Mon Sep 17 00:00:00 2001
From: unspeaker <hora.nqma@protonmail.com>
Date: Mon, 14 Apr 2025 00:14:01 +0300
Subject: [PATCH] model: document all fields

---
 app/src/model.rs | 26 +++++++++++++++++++++-----
 1 file changed, 21 insertions(+), 5 deletions(-)

diff --git a/app/src/model.rs b/app/src/model.rs
index 52b6d829..7b48039e 100644
--- a/app/src/model.rs
+++ b/app/src/model.rs
@@ -15,35 +15,51 @@ mod model_select; pub use self::model_select::*;
     pub editor: Option<MidiEditor>,
     /// Contains a render of the project arrangement, redrawn on update.
     pub arranger: Arc<RwLock<Buffer>>,
+    /// List of global midi inputs
     pub midi_ins: Vec<JackMidiIn>,
+    /// List of global midi outputs
     pub midi_outs: Vec<JackMidiOut>,
+    /// List of global audio inputs
     pub audio_ins: Vec<JackAudioIn>,
+    /// List of global audio outputs
     pub audio_outs: Vec<JackAudioOut>,
+    /// Buffer for writing a midi event
     pub note_buf: Vec<u8>,
+    /// Buffer for writing a chunk of midi events
     pub midi_buf: Vec<Vec<Vec<u8>>>,
-
+    /// List of tracks
     pub tracks: Vec<Track>,
+    /// Scroll offset of tracks
     pub track_scroll: usize,
-
+    /// List of scenes
     pub scenes: Vec<Scene>,
+    /// Scroll offset of scenes
     pub scene_scroll: usize,
-
+    /// Selected UI element
     pub selected: Selection,
+    /// Display size
     pub size: Measure<TuiOut>,
+    /// Performance counter
     pub perf: PerfModel,
+    /// Whether in edit mode
     pub editing: AtomicBool,
+    /// Undo history
     pub history: Vec<TekCommand>,
+    /// Port handles
     pub ports: std::collections::BTreeMap<u32, Port<Unowned>>,
-
     /// View definition
     pub view:       SourceIter<'static>,
     // Input definitions
     pub keys:       SourceIter<'static>,
+    // Input definitions when a clip is focused
     pub keys_clip:  SourceIter<'static>,
+    // Input definitions when a track is focused
     pub keys_track: SourceIter<'static>,
+    // Input definitions when a scene is focused
     pub keys_scene: SourceIter<'static>,
+    // Input definitions when the mix is focused
     pub keys_mix:   SourceIter<'static>,
-
+    // Cache of formatted strings
     pub fmtd: Arc<RwLock<ViewCache>>,
 }
 has_size!(<TuiOut>|self: Tek|&self.size);