Class: YARD::CodeObjects::Chef::Property

Inherits:

Object

• Object
• YARD::CodeObjects::Chef::Property

Defined in:

lib/yard-chefdoc/code_objects/resource.rb

Overview

Simple class to handle Properties and their specifics Full docs here www.rubydoc.info/gems/chef/Chef%2FMixin%2FProperties%2FClassMethods:property

Instance Attribute Summary

• #docstring ⇒ Object

  The name of the property.

• #identifier ⇒ Object

  The name of the property.

• #options ⇒ Object

  The name of the property.

• #type ⇒ Object

  The name of the property.

Instance Method Summary

• #initialize(h) ⇒ Property constructor

  A new instance of Property.

Constructor Details

#initialize(h) ⇒ Property

Returns a new instance of Property.

# File 'lib/yard-chefdoc/code_objects/resource.rb', line 53

def initialize(h)
  h.each { |k, v| instance_variable_set("@#{k}", v) }
end

Instance Attribute Details

#docstring ⇒ Object

The name of the property

# File 'lib/yard-chefdoc/code_objects/resource.rb', line 48

def docstring
  @docstring
end

#identifier ⇒ Object

The name of the property

# File 'lib/yard-chefdoc/code_objects/resource.rb', line 48

def identifier
  @identifier
end

#options ⇒ Object

The name of the property

# File 'lib/yard-chefdoc/code_objects/resource.rb', line 48

def options
  @options
end

#type ⇒ Object

The name of the property

# File 'lib/yard-chefdoc/code_objects/resource.rb', line 48

def type
  @type
end