class YARD::Tags::TypesExplainer

Constants

LITERALMATCH

Regular expression to match symbol and string literals

Public Class Methods

explain(*types) click to toggle source

(see Tag#explain_types) @param types [Array<String>] a list of types to parse and summarize

# File lib/yard/tags/types_explainer.rb, line 12
def self.explain(*types)
  explain!(*types)
rescue SyntaxError
  nil
end
explain!(*types) click to toggle source

(see explain) @raise [SyntaxError] if the types are not parsable

# File lib/yard/tags/types_explainer.rb, line 20
def self.explain!(*types)
  Parser.parse(types.join(", ")).join("; ")
end