0.33
The project is in a healthy, maintained state
A YARD plugin that incorporates Sorbet type information
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

 Project Readme

yard-sorbet

Gem Version Build Status codecov

A YARD plugin that parses Sorbet type annotations

Features

  • Attaches existing documentation to methods and attributes 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
  • Merges sigs in rbi files with source code documentation (rbi files must come after source code in yard configuration)

Usage

See the Plugin Support section of the YARD docs.

Used By

This plugin is used by: