module Puppet::Util::RDoc

Public Instance Methods

manifestdoc(files) click to toggle source

launch an output to console manifest doc

   # File lib/puppet/util/rdoc.rb
36 def manifestdoc(files)
37   raise _("RDOC SUPPORT FOR MANIFEST HAS BEEN REMOVED - See PUP-3638")
38 end
output(file, ast) click to toggle source

Outputs to the console the documentation of a manifest

   # File lib/puppet/util/rdoc.rb
42 def output(file, ast)
43   raise _("RDOC SUPPORT FOR MANIFEST HAS BEEN REMOVED - See PUP-3638")
44 end
output_astnode_doc(ast) click to toggle source
   # File lib/puppet/util/rdoc.rb
46 def output_astnode_doc(ast)
47   raise _("RDOC SUPPORT FOR MANIFEST HAS BEEN REMOVED - See PUP-3638")
48 end
output_resource_doc(code) click to toggle source
   # File lib/puppet/util/rdoc.rb
50 def output_resource_doc(code)
51   raise _("RDOC SUPPORT FOR MANIFEST HAS BEEN REMOVED - See PUP-3638")
52 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
 7 def rdoc(outputdir, files, charset = nil)
 8 
 9   # then rdoc
10   require 'rdoc/rdoc'
11   require 'rdoc/options'
12 
13   # load our parser
14   require_relative 'rdoc/parser'
15 
16   r = RDoc::RDoc.new
17 
18   # specify our own format & where to output
19   options = [ "--fmt", "puppet",
20               "--quiet",
21               "--exclude", "/modules/[^/]*/spec/.*$",
22               "--exclude", "/modules/[^/]*/files/.*$",
23               "--exclude", "/modules/[^/]*/tests/.*$",
24               "--exclude", "/modules/[^/]*/templates/.*$",
25               "--op", outputdir ]
26 
27   options << "--force-update"
28   options += [ "--charset", charset] if charset
29   options += files
30 
31   # launch the documentation process
32   r.document(options)
33 end