A Textmate Bundle for YARD
Pull request Compare This branch is 6 commits ahead of lsegal:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Commands
Preferences
Snippets
README.textile
info.plist

README.textile

Project Description

TextMate Bundle for writing YARD style documentation for ruby scripts
Originally forked from lsegal/yard-tmbundle, I modified it to make it more relevant to my older style of commenting

Installation

mkdir /Library/Application\ Support/Textmate/Bundles/
cd /Library/Application\ Support/Textmate/Bundles/
git clone git://github.com/kunalmodi/yard-tmbundle.git
osascript -e 'tell app "TextMate" to reload bundles'

Snippets

  • ## – Starts documentation
  • api -@api
  • author – @author
  • depr – @deprecated
  • note – @note
  • param – @param
  • raise – @raise
  • return – @return
  • see – @see
  • since – @since
  • todo – @todo
  • version – @version
  • yield – @yield
  • yparam – @yieldparam

TODO

  • A tmLanguage
  • A tmCommand for regenerating the documentation and opening it in the browser