Class: Docscribe::Types::MethodSignature

Inherits:

Struct

• Object
• Struct
• Docscribe::Types::MethodSignature

Defined in:

lib/docscribe/types/signature.rb

Instance Attribute Summary

• #overloads ⇒ Array<Docscribe::Types::MethodSignature>^?
• #param_types ⇒ Hash<String, String>
• #positional_types ⇒ Array<String>
• #rest_keywords ⇒ Docscribe::Types::RestKeywords^?
• #rest_positional ⇒ Docscribe::Types::RestPositional^?
• #return_type ⇒ String

Instance Attribute Details

#overloads ⇒ Array<Docscribe::Types::MethodSignature>^?

Parameters:

• value (Array<Docscribe::Types::MethodSignature>, nil)

Returns:

• (Array<Docscribe::Types::MethodSignature>, nil)

# File 'lib/docscribe/types/signature.rb', line 28

MethodSignature = Struct.new(:return_type, :param_types, :positional_types, :rest_positional, :rest_keywords,
:overloads,
keyword_init: true)

#param_types ⇒ Hash<String, String>

Parameters:

• value (Hash<String, String>)

Returns:

• (Hash<String, String>)

# File 'lib/docscribe/types/signature.rb', line 28

MethodSignature = Struct.new(:return_type, :param_types, :positional_types, :rest_positional, :rest_keywords,
:overloads,
keyword_init: true)

#positional_types ⇒ Array<String>

Parameters:

• value (Array<String>)

Returns:

• (Array<String>)

# File 'lib/docscribe/types/signature.rb', line 28

MethodSignature = Struct.new(:return_type, :param_types, :positional_types, :rest_positional, :rest_keywords,
:overloads,
keyword_init: true)

#rest_keywords ⇒ Docscribe::Types::RestKeywords^?

Parameters:

• value (Docscribe::Types::RestKeywords, nil)

Returns:

• (Docscribe::Types::RestKeywords, nil)

# File 'lib/docscribe/types/signature.rb', line 28

MethodSignature = Struct.new(:return_type, :param_types, :positional_types, :rest_positional, :rest_keywords,
:overloads,
keyword_init: true)

#rest_positional ⇒ Docscribe::Types::RestPositional^?

Parameters:

• value (Docscribe::Types::RestPositional, nil)

Returns:

• (Docscribe::Types::RestPositional, nil)

# File 'lib/docscribe/types/signature.rb', line 28

MethodSignature = Struct.new(:return_type, :param_types, :positional_types, :rest_positional, :rest_keywords,
:overloads,
keyword_init: true)

#return_type ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/docscribe/types/signature.rb', line 28

MethodSignature = Struct.new(:return_type, :param_types, :positional_types, :rest_positional, :rest_keywords,
:overloads,
keyword_init: true)