Module: YARDReadme

Defined in:

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

Overview

A YARD plugin used by readme_yard. It adds a @readme tag to YARD.

It also replaces the default docstring parser so that only @readme tags and not their text values are stripped from the generated documentation. I prefer this over the default YARD behavior for the @readme tag because it allows the comments in the source code to signal the README dependency without pushing the generated YARD documentation into a separate "readme" section.

Defined Under Namespace

Classes: DocstringParser, TagFactory

Constant Summary

VERSION =

"0.3.0"