Method: YARD::DocstringParser#state

Defined in:
lib/yard/docstring_parser.rb

#state ⇒ OpenStruct

Returns any arbitrary state to be passed between tags during parsing. Mainly used by directives to coordinate behaviour (so that directives can be aware of other directives used in a docstring).

Returns:

  • (OpenStruct) —

    any arbitrary state to be passed between tags during parsing. Mainly used by directives to coordinate behaviour (so that directives can be aware of other directives used in a docstring).

Since:

  • 0.8.0



50
51
52
 
# File 'lib/yard/docstring_parser.rb', line 50

def state
  @state
end