Class: YARD::CLI::YardocOptions

Inherits:
Templates::TemplateOptions show all
Defined in:
lib/yard/cli/yardoc.rb

Overview

Default options used in yard doc command.

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

#fileCodeObjects::ExtraFileObject


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

def file
  @file
end

#indexNumeric


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

def index
  @index
end

#itemCodeObjects::Base


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

def item
  @item
end

#localeString


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

def locale
  @locale
end

#objectsArray<CodeObjects::Base>


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

def objects
  @objects
end

#readmeCodeObjects::ExtraFileObject


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

def readme
  @readme
end

Instance Method Details

#filesArray<CodeObjects::ExtraFileObject>


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

default_attr :files, lambda { [] }

#formatSymbol


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

default_attr :format, :html

#onefileBoolean


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

default_attr :onefile, false

#serializerSerializers::Base


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

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

#titleString


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

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

#verifierVerifier


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

default_attr :verifier, lambda { Verifier.new }