class YARD::Templates::TemplateOptions
An Options
class containing default options for base template rendering. For options specific to generation of HTML output, see {CLI::YardocOptions}.
@see CLI::YardocOptions
Attributes
@return [Boolean] whether the page is the “index”
@return [Class] the markup provider class for the markup format
@deprecated use {#highlight} instead. @return [Boolean] whether highlighting should be ignored
@return [CodeObjects::Base] the main object being generated in the template
@return [CodeObjects::Base] the owner of the generated object
@return [String] the title of a given page
@return [Serializers::Base] the serializer used to generate links and serialize
output. Serialization output only occurs if {#serialize} is +true+.
@return [Symbol] the template type used to generate output
@return [Verifier] the verifier object
Public Instance Methods
@param [CodeObjects::Base] mixin accepts any code object, but returns
nil unless the object is a module.
@return [Boolean] whether a mixin matches the embed_mixins list @return [nil] if the mixin is not a module object
# File lib/yard/templates/template_options.rb, line 78 def embed_mixins_match?(mixin) return true if mixin == object # the method is not inherited return nil unless mixin.is_a?(CodeObjects::ModuleObject) embed_mixins.any? do |embed_mixin| re = /\A#{Regexp.quote(embed_mixin).gsub('\*', '.*')}\Z/ matchstr = embed_mixin.include?("::") ? mixin.path : mixin.name re.match(matchstr.to_s) end end
# File lib/yard/templates/template_options.rb, line 58 def no_highlight=(value) self.highlight = !value end