Class: RDoc::Generator::Markdown

Inherits:
Object
  • Object
show all
Includes:
Descriptions, Index, Paths, Signatures
Defined in:
lib/rdoc/generator/markdown.rb

Overview

Generates Markdown output and a CSV search index from an RDoc store.

Defined Under Namespace

Classes: GenerationState

Constant Summary collapse

TEMPLATE_DIR =

Directory containing ERB templates.

File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "templates"))

Constants included from Signatures

Signatures::DELIMITER_PAIRS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Signatures

extract_parameter_name, merge_method_signature_arguments, merged_signature, normalized_method_params, render_method_signature, signature_part_mentions_name?, split_signature_arguments_and_suffix, split_signature_list, top_level_signature_separator?

Methods included from Paths

normalize_input_path, resolve_output_path_from, rewrite_internal_links

Constructor Details

#initialize(store, rdoc_options) ⇒ Markdown

Creates a generator for an RDoc store and options.

Parameters:

  • store (RDoc::Store) —

    Source documentation store.

  • rdoc_options (RDoc::Options) —

    Generator options.



62
63
64
65
66
 
# File 'lib/rdoc/generator/markdown.rb', line 62

def initialize(store, rdoc_options)
  @store = store
  @options = rdoc_options
  @source_dir = File.expand_path(rdoc_options.root.to_s)
end

Instance Attribute Details

#store ⇒ RDoc::Store (readonly)

Source store for generated content.

Returns:

  • (RDoc::Store) 


42
43
44
 
# File 'lib/rdoc/generator/markdown.rb', line 42

def store
  @store
end

Instance Method Details

#classes ⇒ Array<RDoc::Context>?

Classes and modules selected for output.

Returns:

  • (Array<RDoc::Context>, nil) 


47
48
49
 
# File 'lib/rdoc/generator/markdown.rb', line 47

def classes
  generation_state&.classes
end

#generate ⇒ void

This method returns an undefined value.

Writes class files, page files, and the search index.



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/rdoc/generator/markdown.rb', line 71

def generate
  debug("Setting things up ")
  setup

  debug("Generate documentation in #{output_dir}")
  emit_classfiles

  debug("Generate pages in #{output_dir}")
  emit_pagefiles

  debug("Generate index file in #{output_dir}")
  emit_csv_index
end

#pages ⇒ Array<RDoc::TopLevel>?

Text files selected for output.

Returns:

  • (Array<RDoc::TopLevel>, nil) 


54
55
56
 
# File 'lib/rdoc/generator/markdown.rb', line 54

def pages
  generation_state&.pages
end