123456789_123456789_123456789_123456789_123456789_

Class: YARD::CLI::GraphOptions

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::YARD::Templates::TemplateOptions, ::YARD::Options
Instance Chain:
self, ::YARD::Templates::TemplateOptions, ::YARD::Options
Inherits: YARD::Templates::TemplateOptions
Defined in: lib/yard/cli/graph.rb

Overview

Class Method Summary

::YARD::Options - Inherited

.default_attr

Defines an attribute named key and sets a default value for it.

Instance Attribute Summary

::YARD::Templates::TemplateOptions - Inherited

#__globals

Alias for Templates::TemplateOptions#globals.
#default_return, #embed_mixins, #format, #globals, #hide_void_return, #highlight, #index, #markup, #markup_provider, #no_highlight, #no_highlight=, #object, #owner, #page_title, #serialize, #serializer, #template, #type, #verifier

Instance Method Summary

::YARD::Templates::TemplateOptions - Inherited

#embed_mixins_match?

::YARD::Options - Inherited

#==,
#[]

Delegates calls with ::Hash syntax to actual method with key name.
#[]=

Delegates setter calls with ::Hash syntax to the attribute setter with the key name.
#delete

Deletes an option value for key.
#each

Yields over every option key and value.
#inspect

Inspects the object.
#merge

Creates a new options object and sets options hash or object value onto that object.
#method_missing

Handles setting and accessing of unregistered keys similar to an OpenStruct object.
#reset_defaults

Resets all values to their defaults.
#tap

only for 1.8.6.
#to_hash,
#update

Updates values from an options hash or options object on this object.

Dynamic Method Handling

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

Instance Attribute Details

#contents ⇒ String (rw)

Returns:

  • (String) —

    any contents to pass to the digraph

[ GitHub ] 

  


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



attr_accessor :contents


  








  

    #dependencies  ⇒ Boolean  (rw)
  



  

    
  





  
Returns:


    
  
  • 
    (Boolean)
—    
    whether to show the object dependencies
    

    
  
    • 





  [ GitHub ]


  

  


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



attr_accessor :dependencies


  








  

    #full  ⇒ Boolean  (rw)
  



  

    
  





  
Returns:


    
  
  • 
    (Boolean)
—    
    whether to list the full class diagram
    

    
  
    • 





  [ GitHub ]


  

  


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



attr_accessor :full


  







Instance Method Details



  

    #format  ⇒ :dot 
  



  

    
  





  
Returns:


    
  
  • 
    (:dot)
—    
    the default output format
    

    
  
    • 





  [ GitHub ]


  

  


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



default_attr :format, :dot