Module: Puppet::Util::RDoc
- Defined in:
- lib/vendor/puppet/util/rdoc.rb
Class Method Summary collapse
-
.manifestdoc(files) ⇒ Object
launch a output to console manifest doc.
-
.output(file, ast) ⇒ Object
Ouputs to the console the documentation of a manifest.
- .output_astnode_doc(ast) ⇒ Object
- .output_resource_doc(code) ⇒ Object
-
.rdoc(outputdir, files, charset = nil) ⇒ Object
launch a rdoc documenation process with the files/dir passed in
files
.
Class Method Details
.manifestdoc(files) ⇒ Object
launch a output to console manifest doc
44 45 46 47 48 49 50 51 52 |
# File 'lib/vendor/puppet/util/rdoc.rb', line 44 def manifestdoc(files) Puppet[:ignoreimport] = true files.select { |f| FileTest.file?(f) }.each do |f| parser = Puppet::Parser::Parser.new(Puppet::Node::Environment.new(Puppet[:environment])) parser.file = f ast = parser.parse output(f, ast) end end |
.output(file, ast) ⇒ Object
Ouputs to the console the documentation of a manifest
56 57 58 59 60 61 62 63 64 65 |
# File 'lib/vendor/puppet/util/rdoc.rb', line 56 def output(file, ast) astobj = [] ast.instantiate('').each do |resource_type| astobj << resource_type if resource_type.file == file end astobj.sort! {|a,b| a.line <=> b.line }.each do |k| output_astnode_doc(k) end end |
.output_astnode_doc(ast) ⇒ Object
67 68 69 70 71 72 73 74 75 |
# File 'lib/vendor/puppet/util/rdoc.rb', line 67 def output_astnode_doc(ast) puts ast.doc if !ast.doc.nil? and !ast.doc.empty? if Puppet.settings[:document_all] # scan each underlying resources to produce documentation code = ast.code.children if ast.code.is_a?(Puppet::Parser::AST::ASTArray) code ||= ast.code output_resource_doc(code) unless code.nil? end end |
.output_resource_doc(code) ⇒ Object
77 78 79 80 81 82 83 84 85 |
# File 'lib/vendor/puppet/util/rdoc.rb', line 77 def output_resource_doc(code) code.sort { |a,b| a.line <=> b.line }.each do |stmt| output_resource_doc(stmt.children) if stmt.is_a?(Puppet::Parser::AST::ASTArray) if stmt.is_a?(Puppet::Parser::AST::Resource) puts stmt.doc if !stmt.doc.nil? and !stmt.doc.empty? end end end |
.rdoc(outputdir, files, charset = nil) ⇒ Object
launch a rdoc documenation process with the files/dir passed in files
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
# File 'lib/vendor/puppet/util/rdoc.rb', line 8 def rdoc(outputdir, files, charset = nil) Puppet[:ignoreimport] = true # then rdoc require 'rdoc/rdoc' require 'rdoc/options' # load our parser require 'puppet/util/rdoc/parser' r = RDoc::RDoc.new RDoc::RDoc::GENERATORS["puppet"] = RDoc::RDoc::Generator.new( "puppet/util/rdoc/generators/puppet_generator.rb", "PuppetGenerator".intern, "puppet") # specify our own format & where to output = [ "--fmt", "puppet", "--quiet", "--exclude", "/modules/[^/]*/files/.*$", "--exclude", "/modules/[^/]*/templates/.*$", "--op", outputdir ] << "--force-update" if Options::OptionList..any? { |o| o[0] == "--force-update" } += [ "--charset", charset] if charset += files #TODO dedup file paths (not strict duplication sense, parents, children, etc # launch the documentation process r.document() rescue RDoc::RDocError => e raise Puppet::ParseError.new("RDoc error #{e}") end |