Class: PuppetStrings::Yard::Tags::EnumTag

Inherits:

YARD::Tags::OptionTag

• Object
• YARD::Tags::OptionTag
• PuppetStrings::Yard::Tags::EnumTag

Defined in:

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

Overview

Implements an enum tag for describing enumerated value data types

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/enum_tag.rb', line 10

def self.register!
  YARD::Tags::Library.define_tag("puppet.enum", :enum, :with_enums)
  YARD::Tags::Library.visible_tags.place(:enum).after(:option)
end