123456789_123456789_123456789_123456789_123456789_

Class: YARD::CLI::YardocOptions

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
Server::Commands::LibraryIndexOptions, Server::Commands::LibraryOptions
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/yardoc.rb

Overview

Default options used in +yard doc+ command.

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

#file ⇒ CodeObjects::ExtraFileObject (rw)

Returns:

  • (CodeObjects::ExtraFileObject) —

    the file object being rendered. The object key is not used so that a file may be rendered in the context of an object's namespace (for generating links).

[ GitHub ] 

  


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



attr_accessor :file


  








  

    #index  ⇒ Numeric  (rw)
  



  

    
  





  
Returns:


    
  
  • 
    (Numeric)
—    
    An index value for rendering sequentially related templates
    

    
  
    • 





  [ GitHub ]


  

  


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



attr_accessor :index


  








  

    #item  ⇒ CodeObjects::Base  (rw)
  



  

    
  





  
Returns:


    
  
  • 
    (CodeObjects::Base)
—    
    an extra item to send to a template that is not
the main rendered object
    

    
  
    • 





  [ GitHub ]


  

  


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



attr_accessor :item


  








  

    #locale  ⇒ String  (rw)
  



  

    
  





  
Returns:


    
  
  • 
    (String)
—    
    the current locale
    

    
  
    • 





  [ GitHub ]


  

  


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



attr_accessor :locale


  








  

    #objects  ⇒ Array<CodeObjects::Base>  (rw)
  



  

    
  





  
Returns:





  [ GitHub ]


  

  


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



attr_accessor :objects


  








  

    #readme  ⇒ CodeObjects::ExtraFileObject  (rw)
  



  

    
  





  
Returns:





  [ GitHub ]


  

  


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



attr_accessor :readme


  







Instance Method Details



  

    #files  ⇒ Array<CodeObjects::ExtraFileObject> 
  



  

    
  





  
Returns:





  [ GitHub ]


  

  


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



default_attr :files, lambda { [] }


  








  

    #format  ⇒ Symbol 
  



  

    
  





  
Returns:


    
  
  • 
    (Symbol)
—    
    the default output format (:html).
    

    
  
    • 





  [ GitHub ]


  

  


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



default_attr :format, :html


  








  

    #onefile  ⇒ Boolean 
  



  

    
  





  
Returns:


    
  
  • 
    (Boolean)
—    
    whether the data should be rendered in a single page,
if the template supports it.
    

    
  
    • 





  [ GitHub ]


  

  


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



default_attr :onefile, false


  








  

    #serializer  ⇒ Serializers::Base 
  



  

    
  





  
Returns:





  [ GitHub ]


  

  


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



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


  








  

    #title  ⇒ String 
  



  

    
  





  
Returns:


    
  
  • 
    (String)
—    
    the default title appended to each generated page
    

    
  
    • 





  [ GitHub ]


  

  


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



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


  








  

    #verifier  ⇒ Verifier 
  



  

    
  





  
Returns:


    
  
  • 
    (Verifier)
—    
    the default verifier object to filter queries
    

    
  
    • 





  [ GitHub ]


  

  


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



default_attr :verifier, lambda { Verifier.new }