yard-sorbet

A YARD plugin that parses Sorbet type annotations

Features

• Attaches existing documentation to methods and attributs that follow sig declarations. (This information is otherwise discarded.)
• Translates sig type signatures into corresponding YARD tags
• Generates method definitions from T::Struct fields
• Generates constant definitions from T::Enum enums
• Modules marked abstract! or interface! are tagged @abstract
• Modules using mixes_in_class_methods will attach class methods

Usage

See the Plugin Support section of the YARD docs.

Used By

This plugin is used in generating docs for:

• The Homebrew Ruby API
• yard-sorbet itself