YARD::TomDoc

Website / Development / Issues

Build Status

Description

Implements TomDoc syntax for YARD. 'Nuff said.

Instruction

Since yard-tomdoc is a standard YARD plugin, utilize it with yard's --plugin option.

$ yard --plugin yard-tomdoc [...]

Limitations

Before you use yard-tomdoc you should read about the differences between YARD and TomDoc syntax here.

Licensing

Copyright (c) 2010 Loren Segal, Thomas Sawyer

YARD::TomDoc is distributable in accordance with the ters of the MIT licsnse.

See the LICENSE.txt file for details.