Class: PuppetStrings::Yard::Parsers::Puppet::FunctionStatement

Inherits:

ParameterizedStatement

• Object
• Statement
• ParameterizedStatement
• PuppetStrings::Yard::Parsers::Puppet::FunctionStatement

Defined in:

lib/puppet-strings/yard/parsers/puppet/statement.rb

Overview

Implements the Puppet function statement.

Constant Summary

Constants inherited from Statement

Statement::COMMENT_REGEX

Instance Attribute Summary

• #name ⇒ Object readonly

  Returns the value of attribute name.

Attributes inherited from ParameterizedStatement

#parameters

Attributes inherited from Statement

#comments_range, #docstring, #file, #line, #source

Instance Method Summary

• #initialize(object, file) ⇒ FunctionStatement constructor

  Initializes the Puppet function statement.

Methods inherited from Statement

#comments, #comments_hash_flag, #extract_docstring, #show

Constructor Details

#initialize(object, file) ⇒ FunctionStatement

Initializes the Puppet function statement.

Parameters:

• object (Puppet::Pops::Model::FunctionDefinition) —

  The model object for the function statement.

• file (String) —

  The file containing the statement.

# File 'lib/puppet-strings/yard/parsers/puppet/statement.rb', line 141

def initialize(object, file)
  super(object, file)
  @name = object.name
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.

# File 'lib/puppet-strings/yard/parsers/puppet/statement.rb', line 136

def name
  @name
end