Method: Puppet::Indirector::Indirection#doc

Defined in:
lib/puppet/indirector/indirection.rb

#docObject

Generate the full doc string.



79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/puppet/indirector/indirection.rb', line 79

def doc
  text = ""

  text << scrub(@doc) << "\n\n" if @doc

  text << "* **Indirected Class**: `#{@indirected_class}`\n";
  if terminus_setting
    text << "* **Terminus Setting**: #{terminus_setting}\n"
  end

  text
end