123456789_123456789_123456789_123456789_123456789_

Module: YARD::Templates::Helpers::FilterHelper

Relationships & Source Files
Defined in: lib/yard/templates/helpers/filter_helper.rb

Overview

::YARD::Templates::Helpers for various object types

Instance Method Summary

Instance Method Details

#is_class?(object) ⇒ Boolean

Returns:

  • (Boolean) —

    whether an object is a class

[ GitHub ] 

  


# File 'lib/yard/templates/helpers/filter_helper.rb', line 17



def is_class?(object)
  object.is_a?(CodeObjects::ClassObject)
end


  








  

    #is_method?(object)  ⇒ Boolean 
  



  

    
  





  
Returns:


    
  
  • 
    (Boolean)
—    
    whether an object is a method
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/templates/helpers/filter_helper.rb', line 7



def is_method?(object)
  object.type == :method
end


  








  

    #is_module?(object)  ⇒ Boolean 
  



  

    
  





  
Returns:


    
  
  • 
    (Boolean)
—    
    whether an object is a module
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/templates/helpers/filter_helper.rb', line 22



def is_module?(object)
  object.is_a?(CodeObjects::ModuleObject)
end


  








  

    #is_namespace?(object)  ⇒ Boolean 
  



  

    
  





  
Returns:


    
  
  • 
    (Boolean)
—    
    whether an object is a namespace
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/templates/helpers/filter_helper.rb', line 12



def is_namespace?(object)
  object.is_a?(CodeObjects::NamespaceObject)
end