Class: PuppetStrings::Yard::CodeObjects::Providers

Inherits:
Group
  • Object
show all
Defined in:
lib/puppet-strings/yard/code_objects/provider.rb

Overview

Implements the group for Puppet providers.

Class Method Summary collapse

Instance Method Summary collapse

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 (String) —

    The resource type name for the provider.

Returns:

  • Returns the singleton instance of the group.



8
9
10
 
# File 'lib/puppet-strings/yard/code_objects/provider.rb', line 8

def self.instance(type)
  super("puppet_providers_#{type}".intern)
end

Instance Method Details

#name(prefix = false) ⇒ String

Gets the display name of the group.

Parameters:

  • prefix (Boolean) (defaults to: false) —

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

Returns:

  • (String) —

    Returns the display name of the group.



15
16
17
 
# File 'lib/puppet-strings/yard/code_objects/provider.rb', line 15

def name(prefix = false)
  'Providers'
end