Class: YARD::Tags::TypesExplainer

Inherits:

Object

• Object
• YARD::Tags::TypesExplainer

Defined in:

lib/yard/tags/types_explainer.rb

Class Method Summary

• .explain(*types) ⇒ String^?

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

• .explain!(*types) ⇒ String^?

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

Class Method Details

.explain(*types) ⇒ String^?

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

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 parseable

# 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 parseable.

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 parseable

Raises:

• (SyntaxError) —

  if the types are not parseable

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

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