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
@@ -13,6 +13,12 @@ cargo fmt --check
 ruby -c src/ruby_host.rb
 ```

+## Ruby types
+
+Use YARD `@param`, `@return`, and `@yieldparam` annotations for Ruby APIs, and `@type` for locals where inference needs help. Examples annotate DSL block parameters before the call, without adding runtime assignments or dependencies. `Vamp::Action` / `Vamp::Mode` field types and the dynamically defined mode methods use Solargraph-supported directives.
+
+Core action methods are generated from Rust's authoritative catalog at host startup. Their namespace is annotated, but static Solargraph analysis cannot enumerate those generated members. Do not maintain a second action list in Ruby comments; use the [configuration action reference](configuration.md#action-reference).
+
 ## Test organization

 Rust tests live alongside their modules; native LSP integration checks are in [`tests/lsp.rs`](../tests/lsp.rs).