Class: ReadmeYard::CodeTag

Inherits:

Object

• Object
• ReadmeYard::CodeTag

Defined in:

lib/readme_yard/code_tag.rb

Overview

Embed Ruby code

Examples:

# @readme code

Class Method Summary

• .format_tag(yard_object, _tag) ⇒ Object

  The code for this method is in the README because @readme code is below (in the source code).

• .format_yard_object(yard_object) ⇒ Object

Class Method Details

.format_tag(yard_object, _tag) ⇒ Object

The code for this method is in the README because @readme code is below (in the source code).

# File 'lib/readme_yard/code_tag.rb', line 19

def format_tag(yard_object, _tag)
  ExampleTag.format_ruby(yard_object.source)
end

.format_yard_object(yard_object) ⇒ Object

# File 'lib/readme_yard/code_tag.rb', line 23

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