Class: YARD::Tags::GroupDirective
- Defined in:
- lib/yard/tags/directives.rb
Overview
Note:
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.
Parser callbacks collapse
Constructor Details
This class inherits a constructor from YARD::Tags::Directive
Instance Method Details
#call ⇒ Object
122 123 124 125 |
# File 'lib/yard/tags/directives.rb', line 122 def call return unless handler handler.extra_state.group = tag.text end |