Module: YARD::Readme

Defined in:

lib/yard/readme.rb,
lib/yard/readme/version.rb,
lib/yard/readme/description.rb,
lib/yard/readme/tag_factory.rb,
lib/yard/readme/docstring_parser.rb

Defined Under Namespace

Classes: DocstringParser, TagFactory

Constant Summary

VERSION =

"0.6.0"

DESCRIPTION =

String

"A YARD plugin that introduces the @readme tag and powers the readme_yard gem, enabling developers to embed code comments directly into README sections. This eliminates redundancy and keeps documentation consistent across code and project READMEs."