Module: RDoc::Generator::Markdown::OptionsExtension

Included in:
Options
Defined in:
lib/rdoc/generator/markdown.rb

Overview

Adds rdoc-markdown generator configuration to RDoc’s option object.

Instance Method Summary collapse

Instance Method Details

#init_ivarsvoid

This method returns an undefined value.

Initializes markdown generator options alongside RDoc’s built-in options.



26
27
28
29
# File 'lib/rdoc/generator/markdown.rb', line 26

def init_ivars
  super
  @markdown_unknown_tags = :pass_through
end

#init_with(map) ⇒ void

This method returns an undefined value.

Loads markdown generator options from serialized RDoc options.

Parameters:

  • map (Psych::Coder)

    Serialized RDoc options.



36
37
38
39
# File 'lib/rdoc/generator/markdown.rb', line 36

def init_with(map)
  super
  @markdown_unknown_tags = map["markdown_unknown_tags"] if map.map.key?("markdown_unknown_tags")
end

#override(map) ⇒ void

This method returns an undefined value.

Applies markdown generator options from a loaded .rdoc_options hash.

Parameters:

  • map (Hash)

    Loaded RDoc options.



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

def override(map)
  super
  @markdown_unknown_tags = map.fetch("markdown_unknown_tags") if map.key?("markdown_unknown_tags")
end