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


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

def file
  @file
end

#indexNumeric


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

def index
  @index
end

#itemCodeObjects::Base


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

def item
  @item
end

#localeString


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

def locale
  @locale
end

#objectsArray<CodeObjects::Base>


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

def objects
  @objects
end

#readmeCodeObjects::ExtraFileObject


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

def readme
  @readme
end

Instance Method Details

#filesArray<CodeObjects::ExtraFileObject>


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

default_attr :files, lambda { [] }

#formatSymbol


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

default_attr :format, :html

#onefileBoolean


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

default_attr :onefile, false

#serializerSerializers::Base


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

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

#titleString


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

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

#verifierVerifier


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

default_attr :verifier, lambda { Verifier.new }