Class: YARD::CLI::YardocOptions

Inherits:

Templates::TemplateOptions

• Object
• Options
• Templates::TemplateOptions
• YARD::CLI::YardocOptions

show all

Defined in:

lib/yard/cli/yardoc.rb

Overview

Instance Attribute Summary (collapse)

• - (String) default_return inherited from Templates::TemplateOptions

  The default return type for a method with no return tags.

• - (Array<String>) embed_mixins inherited from Templates::TemplateOptions

  An array of module name wildcards to embed into class documentation as if their methods were defined directly in the class.

• - (CodeObjects::ExtraFileObject) file

  The file object being rendered.

• - (Symbol) format inherited from Templates::TemplateOptions

  The template output format.

• - (OpenStruct) globals (also: #__globals) inherited from Templates::TemplateOptions

  An open struct containing any global state across all generated objects in a template.

• - (Boolean) hide_void_return inherited from Templates::TemplateOptions

  Whether void methods should show “void” in their signature.

• - (Boolean) highlight inherited from Templates::TemplateOptions

  Whether code blocks should be syntax highlighted.

• - (Numeric) index

  An index value for rendering sequentially related templates.

• - (CodeObjects::Base) item

  An extra item to send to a template that is not the main rendered object.

• - (Symbol) markup inherited from Templates::TemplateOptions

  The markup format to use when parsing docstrings.

• - (Class) markup_provider inherited from Templates::TemplateOptions

  The markup provider class for the markup format.

• - (Boolean) no_highlight inherited from Templates::TemplateOptions deprecated Deprecated.

  use Templates::TemplateOptions#highlight instead.

• - (CodeObjects::Base) object inherited from Templates::TemplateOptions

  The main object being generated in the template.

• - (Array<CodeObjects::Base>) objects

  The list of code objects to render the templates with.

• - (CodeObjects::Base) owner inherited from Templates::TemplateOptions

  The owner of the generated object.

• - (String) page_title inherited from Templates::TemplateOptions

  The title of a given page.

• - (CodeObjects::ExtraFileObject) readme

  The README file object rendered along with objects.

• - (Boolean) serialize inherited from Templates::TemplateOptions

  Whether serialization should be performed.

• - (Serializers::Base) serializer inherited from Templates::TemplateOptions

  The serializer used to generate links and serialize output.

• - (Symbol) template inherited from Templates::TemplateOptions

  The template name used to render output.

• - (Symbol) type inherited from Templates::TemplateOptions

  The template type used to generate output.

• - (Verifier) verifier inherited from Templates::TemplateOptions

  The verifier object.

Instance Method Summary (collapse)

• - (Array<CodeObjects::ExtraFileObject>) files

  The list of extra files rendered along with objects.

• - (Symbol) format

  The default output format (:html).

• - (Boolean) onefile

  Whether the data should be rendered in a single page, if the template supports it.

• - (Serializers::Base) serializer

  The default serializer for generating output to disk.

• - (String) title

  The default title appended to each generated page.

• - (Verifier) verifier

  The default verifier object to filter queries.

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

47
48
49

# File 'lib/yard/cli/yardoc.rb', line 47

def file
  @file
end

38
39
40

# File 'lib/yard/cli/yardoc.rb', line 38

def index
  @index
end

42
43
44

# File 'lib/yard/cli/yardoc.rb', line 42

def item
  @item
end

35
36
37

# File 'lib/yard/cli/yardoc.rb', line 35

def objects
  @objects
end

31
32
33

# File 'lib/yard/cli/yardoc.rb', line 31

def readme
  @readme
end

10

# File 'lib/yard/cli/yardoc.rb', line 10

default_attr :files, lambda { [] }

23

# File 'lib/yard/cli/yardoc.rb', line 23

default_attr :format, :html

27

# File 'lib/yard/cli/yardoc.rb', line 27

default_attr :onefile, false

20

# File 'lib/yard/cli/yardoc.rb', line 20

default_attr :serializer, lambda { Serializers::FileSystemSerializer.new }

13

# File 'lib/yard/cli/yardoc.rb', line 13

default_attr :title, "Documentation by YARD #{YARD::VERSION}"

16

# File 'lib/yard/cli/yardoc.rb', line 16

default_attr :verifier, lambda { Verifier.new }