Module: Docscribe::Types::Yard

Defined in:
lib/docscribe/types/yard/parser.rb,
lib/docscribe/types/yard/types.rb,
lib/docscribe/types/yard/formatter.rb

Overview

YARD type parser

Defined Under Namespace

Modules: Formatter Classes: Duck, Generic, HashMap, Intersection, Literal, Named, Optional, Parser, Tuple, Union

Class Method Summary collapse

Class Method Details

.parse(string) ⇒ Docscribe::Types::Yard::node?

Parameters:

  • string (String?)

Returns:

  • (Docscribe::Types::Yard::node?) 


12
13
14
15
16
 
# File 'lib/docscribe/types/yard/parser.rb', line 12

def parse(string)
  return nil if string.nil? || string.strip.empty?

  Parser.new(string).parse
end