Class: YARD::CLI::GraphOptions

Inherits:

Templates::TemplateOptions

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

Defined in:

lib/yard/cli/graph.rb

Overview

Options to pass to the Graph CLI.

Instance Attribute Summary

• #contents ⇒ String

  Any contents to pass to the digraph.

• #dependencies ⇒ Boolean

  Whether to show the object dependencies.

• #full ⇒ Boolean

  Whether to list the full class diagram.

Instance Method Summary

• #format ⇒ :dot

  The default output format.

Dynamic Method Handling

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

Instance Attribute Details

#contents ⇒ String

Returns any contents to pass to the digraph.

Returns:

• (String) —

  any contents to pass to the digraph

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

def contents
  @contents
end

#dependencies ⇒ Boolean

Returns whether to show the object dependencies.

Returns:

• (Boolean) —

  whether to show the object dependencies

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

def dependencies
  @dependencies
end

#full ⇒ Boolean

Returns whether to list the full class diagram.

Returns:

• (Boolean) —

  whether to list the full class diagram

# 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

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

default_attr :format, :dot