Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Implements TomDoc syntax markup for YARD
Ruby
tag: 0.7.1

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
pkg
test
work
.gemspec
.gitignore
.index
.option
.rubyrc
.travis.yml
.yardopts
Assembly
Gemfile
HISTORY.md
INDEX.yml
LICENSE.txt
MANIFEST.txt
README.md

README.md

YARD TomDoc

Website / Development / Issues

Build Status Gem Version

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 [...]

Documentation

Limitations

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

Note that the YARD TomDoc plugin now supports a superset of TomDoc's syntax which provides additional YARD functionality via cap-tags. For example using Author: James Deam in the documentation is equivalent to using @author James Dean in regular YARD syntax. Support is limited but it opens up much more of the YARD goodness to TomDoc users then the old blog post geiven above suggests.

Acknowledgements

Huge thanks to Loren Segal, the creator of YARD and the original author of this plugin. Without his patient assistance and coding genius, this library would not have been possible.

Licensing

YARD TomDoc is copyrighted open-source software.

Copyright (c) 2010 Rubyworks. All rights reserved.

YARD TomDoc can be modified and redistributed in accordance with the terms of the MIT licsnse.

See the LICENSE.txt file for details.

Something went wrong with that request. Please try again.