123456789_123456789_123456789_123456789_123456789_

Class: YARD::Server::Commands::LibraryOptions

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

Overview

Since:

  • 0.6.0

Class Method Summary

::YARD::Options - Inherited

.default_attr

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

Instance Attribute Summary

::YARD::CLI::YardocOptions - Inherited

#file, #index, #item, #locale, #objects, #readme

::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::CLI::YardocOptions - Inherited

#files, #format, #onefile, #serializer, #title, #verifier

::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 ::YARD::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

#command (rw)

Since:

  • 0.6.0

[ GitHub ] 

  


# File 'lib/yard/server/commands/library_command.rb', line 14



attr_accessor :command


  








  

    #frames   (rw)
  



  

    
  





  
Since:


    
  
  • 
    
    0.6.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/server/commands/library_command.rb', line 15



attr_accessor :frames


  







Instance Method Details



  

    #adapter  
  



  

    
  





  
Since:


    
  
  • 
    
    0.6.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/server/commands/library_command.rb', line 8



def adapter; @command.adapter end


  








  

    #each {|:adapter, adapter| ... } 
  



  

    
  





  
Yields:



Since:


    
  
  • 
    
    0.6.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/server/commands/library_command.rb', line 17



def each(&block)
  super(&block)
  yield(:adapter, adapter)
  yield(:library, library)
  yield(:single_library, single_library)
  yield(:serializer, serializer)
end


  








  

    #library  
  



  

    
  





  
Since:


    
  
  • 
    
    0.6.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/server/commands/library_command.rb', line 9



def library; @command.library end


  








  

    #serialize  
  



  

    
  





  
Since:


    
  
  • 
    
    0.6.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/server/commands/library_command.rb', line 12



def serialize; false end


  








  

    #serializer  
  



  

    
  





  
Since:


    
  
  • 
    
    0.6.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/server/commands/library_command.rb', line 11



def serializer; @command.serializer end


  








  

    #single_library  
  



  

    
  





  
Since:


    
  
  • 
    
    0.6.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/server/commands/library_command.rb', line 10



def single_library; @command.single_library end