module Puppet::Util::RDoc - Puppet - Configuration Management

manifestdoc(files) click to toggle source

launch an output to console manifest doc

   # File lib/puppet/util/rdoc.rb
37 def manifestdoc(files)
38   raise _("RDOC SUPPORT FOR MANIFEST HAS BEEN REMOVED - See PUP-3638")
39 end

output(file, ast) click to toggle source

Outputs to the console the documentation of a manifest

   # File lib/puppet/util/rdoc.rb
43 def output(file, ast)
44   raise _("RDOC SUPPORT FOR MANIFEST HAS BEEN REMOVED - See PUP-3638")
45 end

output_astnode_doc(ast) click to toggle source

   # File lib/puppet/util/rdoc.rb
47 def output_astnode_doc(ast)
48   raise _("RDOC SUPPORT FOR MANIFEST HAS BEEN REMOVED - See PUP-3638")
49 end

output_resource_doc(code) click to toggle source

   # File lib/puppet/util/rdoc.rb
51 def output_resource_doc(code)
52   raise _("RDOC SUPPORT FOR MANIFEST HAS BEEN REMOVED - See PUP-3638")
53 end

rdoc(outputdir, files, charset = nil) click to toggle source

launch a rdoc documentation process with the files/dir passed in files

   # File lib/puppet/util/rdoc.rb
 8 def rdoc(outputdir, files, charset = nil)
 9 
10   # then rdoc
11   require 'rdoc/rdoc'
12   require 'rdoc/options'
13 
14   # load our parser
15   require_relative 'rdoc/parser'
16 
17   r = RDoc::RDoc.new
18 
19   # specify our own format & where to output
20   options = [ "--fmt", "puppet",
21               "--quiet",
22               "--exclude", "/modules/[^/]*/spec/.*$",
23               "--exclude", "/modules/[^/]*/files/.*$",
24               "--exclude", "/modules/[^/]*/tests/.*$",
25               "--exclude", "/modules/[^/]*/templates/.*$",
26               "--op", outputdir ]
27 
28   options << "--force-update"
29   options += [ "--charset", charset] if charset
30   options += files
31 
32   # launch the documentation process
33   r.document(options)
34 end