Class: PDoc::Generators::Html::DocPage

Inherits:
Page
  • Object
show all
Includes:
Helpers::CodeHelper, Helpers::LinkHelper, Helpers::MenuHelper
Defined in:
lib/pdoc/generators/html/page.rb

Constant Summary

Constants included from Helpers::MenuHelper

Helpers::MenuHelper::LEAVES, Helpers::MenuHelper::NODES

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Helpers::LinkHelper

#auto_link, #auto_link_code, #auto_link_content, #auto_link_types, #dom_id, #path_prefix, #path_to

Methods included from Helpers::CodeHelper

#breadcrumb, #method_synopsis, #methodize_full_name, #methodize_signature

Methods included from Helpers::MenuHelper

#class_names_for, #leaf_submenu, #menu, #menu_item, #node_submenu

Methods inherited from Page

#include, #render, #render_to_file

Methods included from Helpers::BaseHelper

#content_tag, #img_tag, #inline_htmlize, #javascript_include_tag, #link_to, #stylesheet_link_tag, #tag

Constructor Details

#initialize(template, layout = "layout", variables = {}) ⇒ DocPage

Returns a new instance of DocPage.



56
57
58
59
60
61
62
 
# File 'lib/pdoc/generators/html/page.rb', line 56

def initialize(template, layout = "layout", variables = {})
  if layout.is_a?(Hash)
    variables = layout
    layout = "layout"
  end
  super(template, layout, variables)
end

Instance Attribute Details

#depth ⇒ Object (readonly)

Returns the value of attribute depth.



54
55
56
 
# File 'lib/pdoc/generators/html/page.rb', line 54

def depth
  @depth
end

#doc_instance ⇒ Object (readonly)

Returns the value of attribute doc_instance.



54
55
56
 
# File 'lib/pdoc/generators/html/page.rb', line 54

def doc_instance
  @doc_instance
end

#root ⇒ Object (readonly)

Returns the value of attribute root.



54
55
56
 
# File 'lib/pdoc/generators/html/page.rb', line 54

def root
  @root
end

Instance Method Details

#htmlize(markdown) ⇒ Object 



64
65
66
 
# File 'lib/pdoc/generators/html/page.rb', line 64

def htmlize(markdown)
  super(auto_link_content(markdown))
end