Method: Puppet::Reports.reportdocs

Defined in:
lib/puppet/reports.rb

.reportdocsObject

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.

Collects the docs for all reports.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/puppet/reports.rb', line 74

def self.reportdocs
  docs = ''.dup

  # Use this method so they all get loaded
  instance_loader(:report).loadall(Puppet.lookup(:current_environment))
  loaded_instances(:report).sort_by(&:to_s).each do |name|
    mod = report(name)
    docs << "#{name}\n#{'-' * name.to_s.length}\n"

    docs << Puppet::Util::Docs.scrub(mod.doc) << "\n\n"
  end

  docs
end