123456789_123456789_123456789_123456789_123456789_

Class: YARD::CodeObjects::CodeObjectList

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::Array
Instance Chain:
self, ::Array
Inherits: Array
  • Object
Defined in: lib/yard/code_objects/base.rb

Overview

A list of code objects. This array acts like a set (no unique items) but also disallows any Proxy objects from being added.

Class Method Summary

Instance Method Summary

::Array - Inherited

#place

Places values before or after another object (by value) in an array.

Constructor Details

.new(owner = Registry.root) ⇒ CodeObjectList

Creates a new object list associated with a namespace

Parameters:

  • owner (NamespaceObject) (defaults to: Registry.root) —

    the namespace the list should be associated with

[ GitHub ] 

  


# File 'lib/yard/code_objects/base.rb', line 11



def initialize(owner = Registry.root)
  @owner = owner
end


  







Instance Method Details



  

    #<<(value)  
  



  

    
Alias for #push.


  



  [ GitHub ]


  

  


# File 'lib/yard/code_objects/base.rb', line 28



alias << push


  








  

    #push(value)  ⇒ CodeObjectList 
    Also known as: #<<
  



  

    
Adds a new value to the list


  





  
Parameters:


    
  
  • 
    value
    (Base)
—    
    a code object to add
    

    
  
    • 



Returns:


    
  
  • 
    (CodeObjectList)
—    
    self
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/code_objects/base.rb', line 19



def push(value)
  value = Proxy.new(@owner, value) if value.is_a?(String) || value.is_a?(Symbol)
  if value.is_a?(CodeObjects::Base) || value.is_a?(Proxy)
    super(value) unless include?(value)
  else
    raise ArgumentError, "#{value.class} is not a valid CodeObject"
  end
  self
end