Class: Raddocs::Resource

Inherits:

Struct

• Object
• Struct
• Raddocs::Resource

Defined in:

lib/raddocs/models.rb

Overview

Group of examples related to a specific resource, eg “Orders”

Instance Attribute Summary

• #examples ⇒ Array

  Array of IndexExamples.

• #explanation ⇒ Object

  Returns the value of attribute explanation.

• #name ⇒ Object

  Returns the value of attribute name.

Instance Method Summary

• #explanation? ⇒ Boolean

Instance Attribute Details

#examples ⇒ Array

Returns array of IndexExamples.

Returns:

• (Array) —

  array of IndexExamples

# File 'lib/raddocs/models.rb', line 17

def examples
  @examples
end

#explanation ⇒ Object

Returns the value of attribute explanation

Returns:

• (Object) —

  the current value of explanation

# File 'lib/raddocs/models.rb', line 17

def explanation
  @explanation
end

#name ⇒ Object

Returns the value of attribute name

Returns:

• (Object) —

  the current value of name

# File 'lib/raddocs/models.rb', line 17

def name
  @name
end

Instance Method Details

#explanation? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/raddocs/models.rb', line 25

def explanation?
  !explanation.nil?
end