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

Inherits:

Puppet::Pops::Adaptable::Adapter

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

Defined in:

lib/puppet/pops/adapters.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

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).

Instance Attribute Summary

• #documentation ⇒ String private

  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, type_name

Instance Attribute Details

#documentation ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns The documentation associated with an object.

Returns:

• (String) —

  The documentation associated with an object

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

def documentation
  @documentation
end