GitHub - mvidner/yard-medoosa: Enhance YARD documentation by generating class diagrams. (original) (raw)
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:
Requirements
- The Graphviz programs(
dot
andunflatten
)
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.