Module Puppet::Util::Docs
In: lib/puppet/util/docs.rb

Some simple methods for helping manage automatic documentation generation.

Methods

desc   doc   dochook   doctable   nodoc?   pad   scrub  

Attributes

doc  [W] 
nodoc  [R] 

Public Instance methods

Specify the actual doc string.

Generate the full doc string.

Add a new autodoc block. We have to define these as class methods, rather than just sticking them in a hash, because otherwise they‘re too difficult to do inheritance with.

Pad a field with spaces

Handle the inline indentation in the docs.

[Validate]