Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A Textmate Bundle for YARD

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 Commands
Octocat-spinner-32 Preferences
Octocat-spinner-32 Snippets
Octocat-spinner-32 README.textile
Octocat-spinner-32 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
Something went wrong with that request. Please try again.