https://github.com/lsegal/yard-defaultreturn

Default return types for methods in a class/module
https://github.com/lsegal/yard-defaultreturn

Last synced: about 1 month ago
JSON representation

Default return types for methods in a class/module

• Host: GitHub
• URL: https://github.com/lsegal/yard-defaultreturn
• Owner: lsegal
• Created: 2010-05-21T20:37:06.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2010-06-17T17:23:43.000Z (over 14 years ago)
• Last Synced: 2024-11-16T13:50:01.249Z (about 2 months ago)
• Language: Ruby
• Homepage:
• Size: 93.8 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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