Class: YARD::Templates::TemplateOptions

Inherits:
Options
  • Object
show all
Defined in:
lib/yard/templates/template_options.rb

Overview

An Options class containing default options for base template rendering. For options specific to generation of HTML output, see CLI::YardocOptions.

See Also:

Direct Known Subclasses

CLI::GraphOptions, CLI::YardocOptions

Instance Attribute Summary collapse

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class YARD::Options

Instance Attribute Details

#default_returnString


21
# File 'lib/yard/templates/template_options.rb', line 21

default_attr :default_return, "Object"

#embed_mixinsArray<String>

Returns an array of module name wildcards to embed into class documentation as if their methods were defined directly in the class. Useful for modules like ClassMethods. If the name contains '::', the module is matched against the full mixin path, otherwise only the module name is used.

Examples:

A list of mixin path names (including wildcards)

opts.embed_mixins #=> ['ClassMethods', '*Helper', 'YARD::*']

72
# File 'lib/yard/templates/template_options.rb', line 72

default_attr :embed_mixins, lambda { [] }

#formatSymbol


12
# File 'lib/yard/templates/template_options.rb', line 12

default_attr :format, :text

#globalsOpenStruct Also known as: __globals


34
# File 'lib/yard/templates/template_options.rb', line 34

default_attr :globals, lambda { OpenStruct.new }

#hide_void_returnBoolean


24
# File 'lib/yard/templates/template_options.rb', line 24

default_attr :hide_void_return, false

#highlightBoolean


27
# File 'lib/yard/templates/template_options.rb', line 27

default_attr :highlight, true

#indexBoolean


64
65
66
# File 'lib/yard/templates/template_options.rb', line 64

def index
  @index
end

#markupSymbol


18
# File 'lib/yard/templates/template_options.rb', line 18

default_attr :markup, :rdoc

#markup_providerClass


30
31
32
# File 'lib/yard/templates/template_options.rb', line 30

def markup_provider
  @markup_provider
end

#no_highlightBoolean

Deprecated.

use #highlight instead.

Returns whether highlighting should be ignored


55
56
57
# File 'lib/yard/templates/template_options.rb', line 55

def no_highlight
  @no_highlight
end

#objectCodeObjects::Base


38
39
40
# File 'lib/yard/templates/template_options.rb', line 38

def object
  @object
end

#ownerCodeObjects::Base


41
42
43
# File 'lib/yard/templates/template_options.rb', line 41

def owner
  @owner
end

#page_titleString


61
62
63
# File 'lib/yard/templates/template_options.rb', line 61

def page_title
  @page_title
end

#serializeBoolean


47
# File 'lib/yard/templates/template_options.rb', line 47

default_attr :serialize, true

#serializerSerializers::Base


51
52
53
# File 'lib/yard/templates/template_options.rb', line 51

def serializer
  @serializer
end

#templateSymbol


15
# File 'lib/yard/templates/template_options.rb', line 15

default_attr :template, :default

#typeSymbol


44
45
46
# File 'lib/yard/templates/template_options.rb', line 44

def type
  @type
end

#verifierVerifier


89
90
91
# File 'lib/yard/templates/template_options.rb', line 89

def verifier
  @verifier
end

Instance Method Details

#embed_mixins_match?(mixin) ⇒ Boolean?


78
79
80
81
82
83
84
85
86
# 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