Class: YARD::Tags::TypesExplainer
- Inherits:
-
Object
- Object
- YARD::Tags::TypesExplainer
- Defined in:
- lib/yard/tags/types_explainer.rb
Class Method Summary collapse
-
.explain(*types) ⇒ String?
Provides a plain English summary of the type specification, or nil if no types are provided or parsable.
-
.explain!(*types) ⇒ String?
Provides a plain English summary of the type specification, or nil if no types are provided or parsable.
Class Method Details
.explain(*types) ⇒ String?
Provides a plain English summary of the type specification, or nil if no types are provided or parsable.
9 10 11 12 13 |
# 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.
17 18 19 |
# File 'lib/yard/tags/types_explainer.rb', line 17 def self.explain!(*types) Parser.parse(types.join(", ")).join("; ") end |