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

Inherits:

YARD::Tags::Tag

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

Defined in:

lib/puppet-strings/yard/tags/summary_tag.rb

Overview

Implements a summary tag for general purpose short descriptions

Class Method Summary

• .register! ⇒ void

  Registers the tag with YARD.

Class Method Details

.register! ⇒ void

This method returns an undefined value.

Registers the tag with YARD.

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

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