Class: Apiculture::MarkdownSegment

Inherits:

Struct

• Object
• Struct
• Apiculture::MarkdownSegment

Defined in:

lib/apiculture/markdown_segment.rb

Overview

Just a tiny String container for literal documentation chunks

Instance Attribute Summary

• #string ⇒ Object

  Returns the value of attribute string.

Instance Method Summary

• #to_markdown ⇒ Object

Instance Attribute Details

#string ⇒ Object

Returns the value of attribute string

Returns:

• (Object) —

  the current value of string

# File 'lib/apiculture/markdown_segment.rb', line 2

def string
  @string
end

Instance Method Details

#to_markdown ⇒ Object

# File 'lib/apiculture/markdown_segment.rb', line 3

def to_markdown
  string.to_s
end