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

- (String) default_return



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

default_attr :default_return, "Object"

- (Array<String>) embed_mixins

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::*']


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

default_attr :embed_mixins, lambda { [] }

- (Symbol) format



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

default_attr :format, :text

- (OpenStruct) globals Also known as: __globals



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

default_attr :globals, lambda { OpenStruct.new }

- (Boolean) hide_void_return



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

default_attr :hide_void_return, false

- (Boolean) highlight



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

default_attr :highlight, true

- (Symbol) markup



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

default_attr :markup, :rdoc

- (Class) markup_provider



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

def markup_provider
  @markup_provider
end

- (Boolean) no_highlight

Deprecated.

use #highlight instead.

Returns whether highlighting should be ignored



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

def no_highlight
  @no_highlight
end

- (CodeObjects::Base) object



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

def object
  @object
end

- (CodeObjects::Base) owner



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

def owner
  @owner
end

- (String) page_title



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

def page_title
  @page_title
end

- (Boolean) serialize



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

default_attr :serialize, true

- (Serializers::Base) serializer



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

def serializer
  @serializer
end

- (Symbol) template



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

default_attr :template, :default

- (Symbol) type



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

def type
  @type
end

- (Verifier) verifier



85
86
87
# File 'lib/yard/templates/template_options.rb', line 85

def verifier
  @verifier
end

Instance Method Details

- (Boolean?) embed_mixins_match?(mixin)



74
75
76
77
78
79
80
81
82
# File 'lib/yard/templates/template_options.rb', line 74

def embed_mixins_match?(mixin)
  return nil unless mixin.is_a?(CodeObjects::ModuleObject)
  return nil if mixin == object # the method is not inherited
  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