phts / SublimeYardoc

Package for Sublime Text 3. Support for Yardoc in Ruby files.

SublimeYardoc

Package for Sublime Text 3.

This is a fork of the original sublime-yardoc with some my improvements.

Install

Via Package Control:

1. Open Command Palette → Package Control: Add Repository → https://github.com/phts/SublimeYardoc
2. Open Command Palette → Package Control: Install Package → SublimeYardoc

Usage

Pressing ctrl+enter on the line of the method definition

def hello a, b

end

results

#
# [hello description]
# @param a [type] [description]
# @param b [type] [description]
#
# @return [type] [description]
def hello a, b

end

Pressing shift+alt+enter on the line of the class definition

class Hello

end

results

#
# [class description]
#
# @author
#
class Hello

end

Settings

// Determines if empty comment lines have a trailing space
"trailing_spaces": true,

// Add an initial empty line at the beginning of the comment
"initial_empty_line": true,

// Add an empty line at the end of the comment
"trailing_empty_line": false,