Class: ReadmeYard::ValueTag

Inherits:
Object
  • Object
show all
Defined in:
lib/readme_yard/value_tag.rb

Overview

Embed a Ruby value as a Ruby code block

Examples:

# @readme value

Constant Summary collapse

EXAMPLE = 
{ key: "value" }.freeze

Class Method Summary collapse

Class Method Details

.format_tag(yard_object, _tag) ⇒ Object 



18
19
20
21
22
23
24
 
# File 'lib/readme_yard/value_tag.rb', line 18

def format_tag(yard_object, _tag)
  if yard_object.respond_to?(:value)
    "```ruby\n#{yard_object.value}\n```"
  else
    Logger.warn("Cannot parse `@readme value`: #{yard_object.class.name} lacks `value` method.")
  end
end

.format_yard_object(yard_object) ⇒ Object 



26
27
28
 
# File 'lib/readme_yard/value_tag.rb', line 26

def format_yard_object(yard_object)
  format_tag(yard_object, nil)
end