Class: RTFDoc::ResourceDesc

Inherits:
Object
  • Object
show all
Includes:
Anchorable, RenderAsSection
Defined in:
lib/rtfdoc.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Anchorable

#anchor

Methods included from RenderAsSection

#content_to_html, included

Constructor Details

#initialize(resource_name, content) ⇒ ResourceDesc

Returns a new instance of ResourceDesc.



210
211
212
213
 
# File 'lib/rtfdoc.rb', line 210

def initialize(resource_name, content)
  @resource_name  = resource_name
  @content        = content
end

Instance Attribute Details

#resource_name ⇒ Object (readonly)

Returns the value of attribute resource_name.



208
209
210
 
# File 'lib/rtfdoc.rb', line 208

def resource_name
  @resource_name
end

Instance Method Details

#anchor_id ⇒ Object 



219
220
221
 
# File 'lib/rtfdoc.rb', line 219

def anchor_id
  "#{resource_name}-desc"
end

#example_to_html ⇒ Object 



237
238
239
 
# File 'lib/rtfdoc.rb', line 237

def example_to_html
  @example
end

#generate_example(sections) ⇒ Object 



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/rtfdoc.rb', line 223

def generate_example(sections)
  endpoints   = sections.reject { |s| s.name == 'desc' || s.name == 'object' }
  signatures  = endpoints.each_with_object("") do |e, res|
    res << %(<div class="resource-sig">#{e.signature}</div>)
  end

  @example = <<-HTML
  <div class="section-response">
    <div class="response-topbar">ENDPOINTS</div>
    <div class="section-endpoints">#{signatures}</div>
  </div>
  HTML
end

#name ⇒ Object 



215
216
217
 
# File 'lib/rtfdoc.rb', line 215

def name
  'desc'
end