Class: PuppetStrings::Yard::CodeObjects::Functions

Inherits:

Group

• Object
• YARD::CodeObjects::NamespaceObject
• Base
• Group
• PuppetStrings::Yard::CodeObjects::Functions

Defined in:

lib/puppet-strings/yard/code_objects/function.rb

Overview

Implements the group for Puppet functions.

Class Method Summary

• .instance(type) ⇒ Object

  Gets the singleton instance of the group.

Instance Method Summary

• #name(_prefix = false) ⇒ String

  Gets the display name of the group.

Methods inherited from Group

#path, #type

Methods inherited from Base

new

Class Method Details

.instance(type) ⇒ Object

Gets the singleton instance of the group.

Parameters:

• type (Symbol) —

  The function type to get the group for.

Returns:

• Returns the singleton instance of the group.

# File 'lib/puppet-strings/yard/code_objects/function.rb', line 10

def self.instance(type)
  super(:"puppet_functions_#{type}")
end

Instance Method Details

#name(_prefix = false) ⇒ String

Gets the display name of the group.

Parameters:

• prefix (Boolean) —

  whether to show a prefix. Ignored for Puppet group namespaces.

Returns:

• (String) —

  Returns the display name of the group.

# File 'lib/puppet-strings/yard/code_objects/function.rb', line 17

def name(_prefix = false)
  'Puppet Functions'
end