Class: PuppetStrings::Yard::Tags::SummaryTag

Inherits:

YARD::Tags::Tag

Object
YARD::Tags::Tag
PuppetStrings::Yard::Tags::SummaryTag

show all

Defined in:: lib/puppet-strings/yard/tags/summary_tag.rb

Overview

Implements a summary tag for general purpose short descriptions

Class Method Summary collapse

.register! ⇒ void

Registers the tag with YARD.

Class Method Details

.register! ⇒ `void`

This method returns an undefined value.

Registers the tag with YARD.



7
8
9

# File 'lib/puppet-strings/yard/tags/summary_tag.rb', line 7

def self.register!
  YARD::Tags::Library.define_tag('puppet.summary', :summary)
end