ruby-yard-documenter

To generate YARD documentation for Ruby, this Skill identifies undocumented classes and methods, then applies appropriate YARD tags. It uses Solargraph LSP for type inference to ensure tags accurately reflect return types and parameters.

Yes, you can use Solargraph LSP to infer return types for YARD tags. The Skill leverages Solargraph to analyze Ruby code, automatically determining type information and applying the correct YARD tags to your documentation.

You can exclude private or trivial Ruby methods from automated documentation generation through the Skill's intelligent tagging mechanism. It identifies undocumented elements while specifically excluding private or trivial methods, ensuring only relevant code receives YARD tags.

To ensure YARD documentation follows project-specific conventions, the Skill adheres to your project's defined style rules for tone and tag usage. It applies structured YARD tags consistently across classes and methods to enhance clarity and maintainability.

The best way to add YARD tags to a complex Ruby gem is using automated documentation generation. The Skill scans your files to identify undocumented elements, applies appropriate YARD tags using Solargraph for type inference, and saves significant time before release.