Skip to content

kunalmodi/yard-tmbundle

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

A Textmate Bundle for YARD

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published