Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Implements TomDoc syntax markup for YARD

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 etc
Octocat-spinner-32 lib
Octocat-spinner-32 pkg
Octocat-spinner-32 test
Octocat-spinner-32 work
Octocat-spinner-32 .gemspec
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .index
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 .yardopts
Octocat-spinner-32 Assembly
Octocat-spinner-32 Gemfile
Octocat-spinner-32 HISTORY.md
Octocat-spinner-32 INDEX.yml
Octocat-spinner-32 LICENSE.txt
Octocat-spinner-32 MANIFEST.txt
Octocat-spinner-32 README.md
README.md

YARD TomDoc

Website / Documentation / Issues / Source Code

Gem Version Build Status     Flattr Me

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

Limitations

Before you use yard-tomdoc you should read Loren Segal's blog post about the differences between YARD and TomDoc syntax. But 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 YARD's goodness to TomDoc users then Loren's blog post 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.