Method: YARD::Options.default_attr

Defined in:
lib/yard/options.rb

.default_attr(key, default) ⇒ Object

Defines an attribute named key and sets a default value for it

Examples:

Defining a default option key

default_attr :name, 'Default Name'
default_attr :time, lambda { Time.now }

Parameters:

  • key (Symbol) —

    the option key name

  • default (Object, Proc) —

    the default object value. If the default value is a proc, it is executed upon initialization.



80
81
82
83
 
# File 'lib/yard/options.rb', line 80

def self.default_attr(key, default)
  (@defaults ||= {})[key] = default
  attr_accessor(key)
end