Class: Docscribe::InlineRewriter::Collector::Insertion

Inherits:
Struct
  • Object
show all
Defined in:
lib/docscribe/inline_rewriter/collector.rb

Overview

One method that Docscribe intends to document.

Instance Attribute Summary collapse

Instance Attribute Details

#anchor_node ⇒ Parser::AST::Node

Returns first leading Sorbet ‘sig` if present, else the method node.

Returns:

  • (Parser::AST::Node) —

    first leading Sorbet ‘sig` if present, else the method node



38
39
 
# File 'lib/docscribe/inline_rewriter/collector.rb', line 38

Insertion = Struct.new(:node, :scope, :visibility, :container, :module_function, :included_instance_visibility,
:anchor_node)

#container ⇒ String

Returns container name, e.g. “MyModule::MyClass”.

Returns:

  • (String) —

    container name, e.g. “MyModule::MyClass”



38
39
 
# File 'lib/docscribe/inline_rewriter/collector.rb', line 38

Insertion = Struct.new(:node, :scope, :visibility, :container, :module_function, :included_instance_visibility,
:anchor_node)

#included_instance_visibility ⇒ Symbol?

Returns included instance visibility under module_function.

Returns:

  • (Symbol, nil) —

    included instance visibility under module_function



38
39
 
# File 'lib/docscribe/inline_rewriter/collector.rb', line 38

Insertion = Struct.new(:node, :scope, :visibility, :container, :module_function, :included_instance_visibility,
:anchor_node)

#module_function ⇒ Boolean?

Returns true if documented under module_function semantics.

Returns:

  • (Boolean, nil) —

    true if documented under module_function semantics



38
39
 
# File 'lib/docscribe/inline_rewriter/collector.rb', line 38

Insertion = Struct.new(:node, :scope, :visibility, :container, :module_function, :included_instance_visibility,
:anchor_node)

#node ⇒ Parser::AST::Node

Returns the ‘:def` or `:defs` node.

Returns:

  • (Parser::AST::Node) —

    the ‘:def` or `:defs` node



38
39
 
# File 'lib/docscribe/inline_rewriter/collector.rb', line 38

Insertion = Struct.new(:node, :scope, :visibility, :container, :module_function, :included_instance_visibility,
:anchor_node)

#scope ⇒ Symbol

Returns :instance or :class.

Returns:

  • (Symbol) —

    :instance or :class



38
39
 
# File 'lib/docscribe/inline_rewriter/collector.rb', line 38

Insertion = Struct.new(:node, :scope, :visibility, :container, :module_function, :included_instance_visibility,
:anchor_node)

#visibility ⇒ Symbol

Returns :public, :protected, or :private.

Returns:

  • (Symbol) —

    :public, :protected, or :private



38
39
 
# File 'lib/docscribe/inline_rewriter/collector.rb', line 38

Insertion = Struct.new(:node, :scope, :visibility, :container, :module_function, :included_instance_visibility,
:anchor_node)