Class: PuppetStrings::Yard::CodeObjects::Plans

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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Group

#path, #type

Methods inherited from Base

new

Class Method Details

.instance ⇒ Object

Gets the singleton instance of the group.

Returns:

  • Returns the singleton instance of the group.



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

def self.instance
  super(:puppet_plans)
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/plan.rb', line 15

def name(prefix = false)
  'Puppet Plans'
end