Skip to content
Enhance YARD documentation by generating class diagrams.
Ruby
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
.gitignore
.rubocop.yml
Gemfile
README.md
VERSION
yard-medoosa.gemspec

README.md

YARD Medoosa

Enhance YARD documentation by generating class diagrams.

Usage

Add --plugin medoosa to your .yardopts.

During yard doc, Medoosa will produce diagrams in the output directory, linked in the Files section:

  • medoosa-nesting.svg (with classes hyperlinked into the rest of the docs)
  • medoosa-nesting.png

Example output:

medoosa-nesting small

Requirements

Name

If I remember correctly, Medusa was a mythical woman with hair so tangled that a single look of it made people turn into stone. Medoosa is the Object Oriented reincarnation, except it produces diagrams that are much less tangled. yard-medoosa is inspired by the original C++ Medoosa.

You can’t perform that action at this time.