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
tree: d3a15bdaca

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.gemspec
.gitignore
.ruby
.travis.yml
.yardopts
Assembly
Gemfile
HISTORY.md
MANIFEST
MIT.txt
NOTICE.md
Profile
README.md
Rakefile

README.md

yard-tomdoc

Author: Thomas Sawyer <transfire@gmail.com>
Copyright: (c) 2010 Loren Segal, Thomas Sawyer
Home: http://rubyworks.github.com/yard-tomdoc
Issues: http://github.com/rubyworks/yard-tomdoc/issues
Status: Build Status

Description

Implements TomDoc syntax for YARD. 'Nuff said.

Usage

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

See the NOTICE file for license information on TomDoc.

Something went wrong with that request. Please try again.