Class: Docspec::Document

Inherits:

Object

• Object
• Docspec::Document

Defined in:

lib/docspec/document.rb

Instance Attribute Summary

• #filename ⇒ Object readonly

  Returns the value of attribute filename.

Instance Method Summary

• #examples ⇒ Object
• #initialize(filename) ⇒ Document constructor

  A new instance of Document.

• #markdown ⇒ Object

Constructor Details

#initialize(filename) ⇒ Document

Returns a new instance of Document.

# File 'lib/docspec/document.rb', line 5

def initialize(filename)
  @filename = filename
end

Instance Attribute Details

#filename ⇒ Object (readonly)

Returns the value of attribute filename.

# File 'lib/docspec/document.rb', line 3

def filename
  @filename
end

Instance Method Details

#examples ⇒ Object

# File 'lib/docspec/document.rb', line 13

def examples
  @examples ||= examples!
end

#markdown ⇒ Object

# File 'lib/docspec/document.rb', line 9

def markdown
  @markdown ||= File.read filename
end