Class: YARD::Tags::GroupDirective
- Defined in:
- lib/yard/tags/directives.rb
Overview
A group definition only applies to the scope it is defined in. If a new class or module is opened after the directive, this directive will not apply to methods in that class or module.
Defines a group listing. All methods (and attributes) seen after this directive are placed into a group with the given description as the group name. The group listing is used by templates to organize methods and attributes into respective logical groups. To end a group listing use @!endgroup.
Instance Attribute Summary collapse
-
#expanded_text ⇒ String?
inherited
from Directive
Set this field to replace the directive definition inside of a docstring with arbitrary text.
-
#handler ⇒ Handlers::Base?
inherited
from Directive
readonly
The handler object the docstring parser might be attached to.
-
#object ⇒ CodeObjects::Base?
inherited
from Directive
readonly
The object the parent docstring is attached to.
-
#parser ⇒ DocstringParser
inherited
from Directive
protected
The parser that is parsing all tag information out of the docstring.
-
#tag ⇒ Tag
inherited
from Directive
The meta-data tag containing data input to the directive.
Parser callbacks collapse
Constructor Details
This class inherits a constructor from YARD::Tags::Directive
Instance Attribute Details
#expanded_text ⇒ String? Originally defined in class Directive
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.
#handler ⇒ Handlers::Base? (readonly) Originally defined in class Directive
Returns the handler object the docstring parser might be attached to. May be nil. Only available when parsing through Parser::SourceParser.
#object ⇒ CodeObjects::Base? (readonly) Originally defined in class Directive
Returns the object the parent docstring is attached to. May be nil.
#parser ⇒ DocstringParser (protected) Originally defined in class Directive
Returns the parser that is parsing all tag information out of the docstring
Instance Method Details
#call ⇒ Object
121 122 123 124 |
# File 'lib/yard/tags/directives.rb', line 121 def call return unless handler handler.extra_state.group = tag.text end |