class ReadmeYard::ReadmeTag
@readme
By default, only the text nested under the @readme tag will be embedded in the final output. Different embed options are provided via the following name options: `comment`, `source`, and `object`.
@see ReadmeYard::CommentTag
@see ReadmeYard::SourceTag
@see ReadmeYard::ObjectTag
Public Class Methods
format_markdown(yard_object, yard_tags)
click to toggle source
# File lib/readme_yard/readme_tag.rb, line 16 def format_markdown(yard_object, yard_tags) md = +"" yard_tags.each do |tag| res = format_yard_tag(yard_object, tag) md << res if res end md end
format_tag_markdown(_yard_object, tag)
click to toggle source
# File lib/readme_yard/readme_tag.rb, line 25 def format_tag_markdown(_yard_object, tag) "#{tag.text}\n" end
Private Class Methods
format_yard_tag(yard_object, tag)
click to toggle source
# File lib/readme_yard/readme_tag.rb, line 31 def format_yard_tag(yard_object, tag) if tag.name && !tag.name.empty? tag_class = ReadmeYard.lookup_tag_class(tag.name) tag_class&.format_tag_markdown(yard_object, tag) elsif tag.text && !tag.text.empty? format_tag_markdown(yard_object, tag) end end