Method: YARD::Tags::Directive#expanded_text

Defined in:
lib/yard/tags/directives.rb

#expanded_text ⇒ String?

Set this field to replace the directive definition inside of a docstring with arbitrary text. For instance, the MacroDirective uses this field to expand its macro data in place of the call to a @!macro.

Returns:

  • (String) —

    the text to expand in the original docstring in place of this directive definition.

  • (nil) —

    if no expansion should take place for this directive

Since:

  • 0.8.0



33
34
35
 
# File 'lib/yard/tags/directives.rb', line 33

def expanded_text
  @expanded_text
end