Module YARD::Generators::Helpers::HtmlHelper
In: lib/yard/generators/helpers/html_helper.rb

Methods

anchor_for   fix_dash_dash   fix_typewriter   format_object_name_list   format_types   h   htmlify   link_file   link_object   link_url   resolve_links   tag_attrs   url_for   url_for_file   urlencode  

Included Modules

MarkupHelper HtmlSyntaxHighlightHelper

Constants

SimpleMarkupHtml = RUBY19 ? RDoc::Markup::ToHtml.new : SM::ToHtml.new

Public Instance methods

fix_dash_dash(text)

Don‘t allow — to turn into &8212; element. The chances of this being some —option is far more likely than the typographical meaning.

@todo Refactor into own SimpleMarkup subclass

fix_typewriter(text)

@todo Refactor into own SimpleMarkup subclass

format_types(typelist, brackets = true)

Formats a list of types from a tag.

@param [Array<String>, FalseClass] typelist 

  the list of types to be formatted.

@param [Boolean] brackets omits the surrounding 

  brackets if +brackets+ is set to +false+.

@return [String] the list of types formatted 

  as [Type1, Type2, ...] with the types linked
  to their respective descriptions.

[Validate]