Class: YARD::CLI::GraphOptions

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

Overview

Options to pass to the Graph CLI.

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

#contentsString

Returns any contents to pass to the digraph

Returns:

  • (String)

    any contents to pass to the digraph



15
16
17
# File 'lib/yard/cli/graph.rb', line 15

def contents
  @contents
end

#dependenciesBoolean

Returns whether to show the object dependencies

Returns:

  • (Boolean)

    whether to show the object dependencies



12
13
14
# File 'lib/yard/cli/graph.rb', line 12

def dependencies
  @dependencies
end

#fullBoolean

Returns whether to list the full class diagram

Returns:

  • (Boolean)

    whether to list the full class diagram



9
10
11
# File 'lib/yard/cli/graph.rb', line 9

def full
  @full
end

Instance Method Details

#format:dot

Returns the default output format

Returns:

  • (:dot)

    the default output format



6
# File 'lib/yard/cli/graph.rb', line 6

default_attr :format, :dot