Module: Puppet::Util::RDoc

Defined in:
lib/puppet/util/rdoc.rb

Class Method Summary collapse

Class Method Details

.manifestdoc(files) ⇒ Object

launch a output to console manifest doc



42
43
44
45
46
47
48
49
50
 
# File 'lib/puppet/util/rdoc.rb', line 42

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/puppet/util/rdoc.rb', line 54

def output(file, ast)
  astobj = []
  ast.nodes.each do |name, k|
    astobj << k if k.file == file
  end

  ast.hostclasses.each do |name,k|
    astobj << k if k.file == file
  end

  ast.definitions.each do |name, k|
    astobj << k if k.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 



72
73
74
75
76
77
78
79
80
 
# File 'lib/puppet/util/rdoc.rb', line 72

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 



82
83
84
85
86
87
88
89
90
 
# File 'lib/puppet/util/rdoc.rb', line 82

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
 
# File 'lib/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
    options = [ "--fmt", "puppet",
      "--quiet",
      "--exclude", "/modules/[^/]*/files/.*\.pp$",
      "--op", outputdir ]

    options << "--force-update" if Options::OptionList.options.any? { |o| o[0] == "--force-update" }
    options += [ "--charset", charset] if charset
    options += files

    # launch the documentation process
    r.document(options)
rescue RDoc::RDocError => e
    raise Puppet::ParseError.new("RDoc error #{e}")
end