Default return types for methods in a class/module
Ruby
Latest commit fc32ecc Jun 17, 2010 @lsegal Bump 1.0.1
Permalink
Failed to load latest commit information.
lib
README.md
Rakefile
yard-defaultreturn.gemspec

README.md

yard-defaultreturn

Adds @defaultreturn tag to classes/modules to define a return tag on every method in the namespace.

Usage

Using @defaultreturn will automatically declare @return tags on methods without any return type defined inside the class/module:

# @defaultreturn [Boolean] the boolean value
class A
  def foo; end

  # @return [Array] override default
  def bar; end
end

Install

gem install yard-defaultreturn

or checkout source and

rake install