123456789_123456789_123456789_123456789_123456789_

Class: YARD::Tags::TypesExplainer

Relationships & Source Files
Namespace Children
Classes:
CollectionType, FixedCollectionType, HashCollectionType, Parser, Type
Inherits: Object
Defined in: lib/yard/tags/types_explainer.rb

Class Method Summary

Class Method Details

.explain(*types) ⇒ String?

Provides a plain English summary of the type specification, or nil if no types are provided or parsable.

Parameters:

  • types (Array<String>) —

    a list of types to parse and summarize

Returns:

  • (String) —

    a plain English description of the associated types

  • (nil) —

    if no types are provided or not parsable

[ GitHub ] 

  


# File 'lib/yard/tags/types_explainer.rb', line 9



def self.explain(*types)
  explain!(*types)
rescue SyntaxError
  nil
end


  








  

    .explain!(*types)  ⇒ String? 
  



  

    
Provides a plain English summary of the type specification, or nil
if no types are provided or parsable.


  





  
Parameters:


    
  
  • 
    types
    (Array<String>)
—    
    a list of types to parse and summarize
    

    
  
    • 



Returns:


    
  
  • 
    (String)
—    
    a plain English description of the associated types
    

    
  
    • 
  
  • 
    (nil)
—    
    if no types are provided or not parsable
    

    
  
    • 



Raises:


    
  
  • 
    (SyntaxError)
—    
    if the types are not parsable
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/tags/types_explainer.rb', line 17



def self.explain!(*types)
  Parser.parse(types.join(", ")).join("; ")
end