Class: Puppet::Pops::Adapters::DocumentationAdapter

Inherits:

Puppet::Pops::Adaptable::Adapter

• Object
• Puppet::Pops::Adaptable::Adapter
• Puppet::Pops::Adapters::DocumentationAdapter

Defined in:

lib/puppet/pops/adapters.rb

Overview

A documentation adapter adapts an object with a documentation string. (The intended use is for a source text parser to extract documentation and store this in DocumentationAdapter instances).

Constant Summary

Constants inherited from Puppet::Pops::Adaptable::Adapter

Puppet::Pops::Adaptable::Adapter::DOUBLE_COLON, Puppet::Pops::Adaptable::Adapter::USCORE

Instance Attribute Summary

• #documentation ⇒ String

  The documentation associated with an object.

Method Summary

Methods inherited from Puppet::Pops::Adaptable::Adapter

adapt, adapt_new, associate_adapter, clear, create_adapter, get, instance_var_name, self_attr_name

Instance Attribute Details

#documentation ⇒ String

Returns The documentation associated with an object.

# File 'lib/puppet/pops/adapters.rb', line 10

def documentation
  @documentation
end