yard
https://github.com/lsegal/yard
Ruby
YARD is a Ruby Documentation tool. The Y stands for "Yay!"
Triage Issues!
When you volunteer to triage issues, you'll receive an email each day with a link to an open issue that needs help in this project. You'll also receive instructions on how to triage issues.
Triage Docs!
Receive a documented method or class from your favorite GitHub repos in your inbox every day. If you're really pro, receive undocumented methods or classes and supercharge your commit history.
6 Subscribers
Add a CodeTriage badge to yard
Help out
- Issues
- Support class Foo < Data.define(:a, :b) as a documented superclass
- Sidebar navigation hidden on small screens with no way to open it
- No general grouping syntax for unions nested inside tuples, intersections, etc.
- Add intersection ("A & B") and union ("A | B" / "[A | B]") type syntax
- Anonymous collection/hash shorthand (<A>, (A), {A=>B}) documented at yardoc.org/types but not in docs/Tags.md
- globals.rb pollutes the global namespace
- Should we adopt @generic tag as a YARD standard?
- Aliki
- Add class reference to macros
- Allow using Prism for parsing
- Docs
- YARD::Parser::RBS::RbsParser#initialize
- #inherited_methods_by_group
- YARD::Parser::Ruby::RipperParser#on_rbrace
- YARD::Parser::Ruby::RipperParser#on_fndptn
- YARD::Parser::Ruby::RipperParser#on_aryptn
- YARD::Parser::Ruby::RipperParser#on_hshptn
- YARD::Handlers::RBS::MixinHandler#process
- YARD::Handlers::RBS::MethodHandler#add_overload_tag
- YARD::Handlers::RBS::MethodHandler#add_param_return_tags
- YARD::Handlers::RBS::MethodHandler#apply_signature_tags