Class Puppet::Module::Tool::ContentsDescription
In: lib/puppet/module/tool/contents_description.rb
Parent: Object

ContentsDescription

This class populates Metadata‘s Puppet type information.

Methods

annotate   attr_doc   data   new   provider_doc  

Public Class methods

Instantiate object for string module_path.

Public Instance methods

Update Metadata‘s Puppet type information.

Return an array of hashes representing this type‘s attrs of kind (e.g. :param or :property), each containing :name and :doc.

Return types for this module. Result is an array of hashes, each of which describes a Puppet type. The type description hash structure is:

  • :name => Name of this Puppet type.
  • :doc => Documentation for this type.
  • :properties => Array of hashes representing the type‘s properties, each containing :name and :doc.
  • :parameters => Array of hashes representing the type‘s parameters, each containing :name and :doc.
  • :providers => Array of hashes representing the types providers, each containing :name and :doc.

TODO Write a TypeDescription to encapsulate these structures and logic?

Return an array of hashes representing this type‘s providers, each containing :name and :doc.

[Validate]