Class: MarkdownRubyDocumentation::Summary

Inherits:
Object
  • Object
show all
Defined in:
lib/markdown_ruby_documentation/summary.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(subject:, erb_methods_class:) ⇒ Summary

Returns a new instance of Summary.



5
6
7
8
 
# File 'lib/markdown_ruby_documentation/summary.rb', line 5

def initialize(subject:, erb_methods_class:)
  @subject           = subject
  @erb_methods_class = erb_methods_class
end

Instance Attribute Details

#erb_methods_class ⇒ Object (readonly)

Returns the value of attribute erb_methods_class.



3
4
5
 
# File 'lib/markdown_ruby_documentation/summary.rb', line 3

def erb_methods_class
  @erb_methods_class
end

#subject ⇒ Object (readonly)

Returns the value of attribute subject.



3
4
5
 
# File 'lib/markdown_ruby_documentation/summary.rb', line 3

def subject
  @subject
end

Instance Method Details

#summary ⇒ Object 



14
15
16
 
# File 'lib/markdown_ruby_documentation/summary.rb', line 14

def summary
  "Descendants: #{descendants_links.join(", ")}" if descendants.present?
end

#title ⇒ Object 



10
11
12
 
# File 'lib/markdown_ruby_documentation/summary.rb', line 10

def title
  [format_class(subject), *ancestors_links].join(" < ")
end