Class: YARD::CLI::YardocOptions

Inherits:

Templates::TemplateOptions

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

Defined in:

lib/yard/cli/yardoc.rb

Overview

Default options used in yard doc command.

Direct Known Subclasses

Server::Commands::LibraryIndexOptions, Server::Commands::LibraryOptions

Instance Attribute Summary

• #file ⇒ CodeObjects::ExtraFileObject

  The file object being rendered.

• #index ⇒ Numeric

  An index value for rendering sequentially related templates.

• #item ⇒ CodeObjects::Base

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

• #locale ⇒ String

  The current locale.

• #objects ⇒ Array<CodeObjects::Base>

  The list of code objects to render the templates with.

• #readme ⇒ CodeObjects::ExtraFileObject

  The README file object rendered along with objects.

Instance Method Summary

• #files ⇒ Array<CodeObjects::ExtraFileObject>

  The list of extra files rendered along with objects.

• #format ⇒ Symbol

  The default output format (:html).

• #onefile ⇒ Boolean

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

• #serializer ⇒ Serializers::Base

  The default serializer for generating output to disk.

• #title ⇒ String

  The default title appended to each generated page.

• #verifier ⇒ Verifier

  The default verifier object to filter queries.

Dynamic Method Handling

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

Instance Attribute Details

#file ⇒ CodeObjects::ExtraFileObject

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

def file
  @file
end

#index ⇒ Numeric

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

def index
  @index
end

#item ⇒ CodeObjects::Base

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

def item
  @item
end

#locale ⇒ String

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

def locale
  @locale
end

#objects ⇒ Array<CodeObjects::Base>

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

def objects
  @objects
end

#readme ⇒ CodeObjects::ExtraFileObject

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

def readme
  @readme
end

Instance Method Details

#files ⇒ Array<CodeObjects::ExtraFileObject>

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

default_attr :files, lambda { [] }

#format ⇒ Symbol

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

default_attr :format, :html

#onefile ⇒ Boolean

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

default_attr :onefile, false

#serializer ⇒ Serializers::Base

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

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

#title ⇒ String

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

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

#verifier ⇒ Verifier

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

default_attr :verifier, lambda { Verifier.new }