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

Attributes inherited from Templates::TemplateOptions

#default_return, #embed_mixins, #globals, #hide_void_return, #highlight, #index, #markup, #markup_provider, #no_highlight, #object, #owner, #page_title, #serialize, #serializer, #template, #type, #verifier

Instance Method Summary collapse

Methods inherited from Templates::TemplateOptions

#embed_mixins_match?

Methods inherited from Options

#==, #[], #[]=, default_attr, #delete, #each, #inspect, #merge, #method_missing, #reset_defaults, #tap, #to_hash, #update

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



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

def contents
  @contents
end

#dependencies ⇒ Boolean

Returns whether to show the object dependencies.

Returns:

  • (Boolean) —

    whether to show the object dependencies



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

def dependencies
  @dependencies
end

#full ⇒ Boolean

Returns whether to list the full class diagram.

Returns:

  • (Boolean) —

    whether to list the full class diagram



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

def full
  @full
end

Instance Method Details

#format ⇒ :dot

Returns the default output format.

Returns:

  • (:dot) —

    the default output format



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

default_attr :format, :dot