Skip to content

mvidner/yard-medoosa

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

Enhance YARD documentation by generating class diagrams.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages