yardoc

What problem does it solve?

YARD documentation generation for Ruby code is often manual and error-prone; this skill automates the creation of precise YARD annotations by performing AST analysis and type inference, ensuring consistency with project conventions and YARD configuration.

Core Features & Use Cases

• Semantic AST analysis identifies class, module, and method shapes to generate accurate documentation blocks.
• Automatic generation of @param, @return, @example, and @raise tags with precise types and usage notes.
• Validation against existing project patterns and YARD configuration to preserve consistency.
• Seamless integration that inserts or updates YARD comments in source files and provides a post-generation quality report.

Quick Start

Document a Ruby file by applying the yardoc skill to generate YARD annotations in-place.