docs: annotate Ruby configuration and plugin APIs with YARD types

2026-10-09 20:19:44 +02:00
parent 9629655206
commit bbb61c2fdd
6 changed files with 133 additions and 1 deletions
@@ -9,6 +9,7 @@ By default, vamp loads `$XDG_CONFIG_HOME/vamp/config.rb`, or `~/.config/vamp/con
 Rejected configuration opens a centered floating **Configuration error** window, sized like the floating file explorer. It shows the selected config path, full failure reason, and explains that default settings and bindings are in use. The diagnostic remains visible even if background messages arrive; editing keys and paste are ignored until **Enter** or **Escape** dismisses it. Use arrows (or Ctrl+h/j/k/l) to scroll long paths/reasons horizontally or vertically, and **Home** to reset the view. Correct the config and restart vamp to apply it. Invalid individual preferences/bindings that do not reject the whole configuration still report ordinary notices.

 ```ruby
+# @param config [Vamp::Config]
 Vamp.configure do |config|
  config.leader = "space"
  config.clipboard_mode = "system"