Class: Docscribe::Plugin::Context

Inherits:
Struct
  • Object
show all
Defined in:
lib/docscribe/plugin/context.rb

Instance Attribute Summary collapse

Instance Attribute Details

#container ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/docscribe/plugin/context.rb', line 36

Context = Struct.new(
  :node,
  :container,
  :scope,
  :visibility,
  :method_name,
  :inferred_params,
  :inferred_return,
  :source,
  keyword_init: true
)

#inferred_params ⇒ Hash<String, String>

Parameters:

  • value (Hash<String, String>)

Returns:

  • (Hash<String, String>) 


36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/docscribe/plugin/context.rb', line 36

Context = Struct.new(
  :node,
  :container,
  :scope,
  :visibility,
  :method_name,
  :inferred_params,
  :inferred_return,
  :source,
  keyword_init: true
)

#inferred_return ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/docscribe/plugin/context.rb', line 36

Context = Struct.new(
  :node,
  :container,
  :scope,
  :visibility,
  :method_name,
  :inferred_params,
  :inferred_return,
  :source,
  keyword_init: true
)

#method_name ⇒ Symbol

Parameters:

  • value (Symbol)

Returns:

  • (Symbol) 


36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/docscribe/plugin/context.rb', line 36

Context = Struct.new(
  :node,
  :container,
  :scope,
  :visibility,
  :method_name,
  :inferred_params,
  :inferred_return,
  :source,
  keyword_init: true
)

#node ⇒ Parser::AST::Node

Parameters:

  • value (Parser::AST::Node)

Returns:

  • (Parser::AST::Node) 


36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/docscribe/plugin/context.rb', line 36

Context = Struct.new(
  :node,
  :container,
  :scope,
  :visibility,
  :method_name,
  :inferred_params,
  :inferred_return,
  :source,
  keyword_init: true
)

#scope ⇒ Symbol

Parameters:

  • value (Symbol)

Returns:

  • (Symbol) 


36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/docscribe/plugin/context.rb', line 36

Context = Struct.new(
  :node,
  :container,
  :scope,
  :visibility,
  :method_name,
  :inferred_params,
  :inferred_return,
  :source,
  keyword_init: true
)

#source ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/docscribe/plugin/context.rb', line 36

Context = Struct.new(
  :node,
  :container,
  :scope,
  :visibility,
  :method_name,
  :inferred_params,
  :inferred_return,
  :source,
  keyword_init: true
)

#visibility ⇒ Symbol

Parameters:

  • value (Symbol)

Returns:

  • (Symbol) 


36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/docscribe/plugin/context.rb', line 36

Context = Struct.new(
  :node,
  :container,
  :scope,
  :visibility,
  :method_name,
  :inferred_params,
  :inferred_return,
  :source,
  keyword_init: true
)