Method: Puppet::Indirector::Indirection#doc

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

#docObject

Generate the full doc string.



87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/puppet/indirector/indirection.rb', line 87

def doc
  text = ''.dup

  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