summaryrefslogtreecommitdiffstats
path: root/lib/puppet/util/rdoc/parser.rb
diff options
context:
space:
mode:
authorBrice Figureau <brice-puppet@daysofwonder.com>2009-10-15 20:22:46 +0200
committerJames Turnbull <james@lovedthanlost.net>2009-10-24 08:36:58 +1100
commit8d9fbbd4b9d7f1d467ea6123fedcf0ee74f4e8cc (patch)
tree4d077ecbd90400fc3b779dd0b529f4735e9fc096 /lib/puppet/util/rdoc/parser.rb
parent41b7c3c70082a03563a6b59f23e72ba3735e6efe (diff)
downloadpuppet-8d9fbbd4b9d7f1d467ea6123fedcf0ee74f4e8cc.tar.gz
puppet-8d9fbbd4b9d7f1d467ea6123fedcf0ee74f4e8cc.tar.xz
puppet-8d9fbbd4b9d7f1d467ea6123fedcf0ee74f4e8cc.zip
Fix #2703 - add 'require' to puppetdoc
Puppetdoc wasn't parsing 'require'. This patch adds a 'require' section to list all required class from nodes and classes. Signed-off-by: Brice Figureau <brice-puppet@daysofwonder.com>
Diffstat (limited to 'lib/puppet/util/rdoc/parser.rb')
-rw-r--r--lib/puppet/util/rdoc/parser.rb14
1 files changed, 7 insertions, 7 deletions
diff --git a/lib/puppet/util/rdoc/parser.rb b/lib/puppet/util/rdoc/parser.rb
index 554f8cb00..6d0e8f7cc 100644
--- a/lib/puppet/util/rdoc/parser.rb
+++ b/lib/puppet/util/rdoc/parser.rb
@@ -147,14 +147,14 @@ class Parser
# create documentation for include statements we can find in +code+
# and associate it with +container+
- def scan_for_include(container, code)
+ def scan_for_include_or_require(container, code)
code.each do |stmt|
- scan_for_include(container,stmt.children) if stmt.is_a?(Puppet::Parser::AST::ASTArray)
+ scan_for_include_or_require(container,stmt.children) if stmt.is_a?(Puppet::Parser::AST::ASTArray)
- if stmt.is_a?(Puppet::Parser::AST::Function) and stmt.name == "include"
+ if stmt.is_a?(Puppet::Parser::AST::Function) and ['include','require'].include?(stmt.name)
stmt.arguments.each do |included|
- Puppet.debug "found include: %s" % included.value
- container.add_include(Include.new(included.value, stmt.doc))
+ Puppet.debug "found #{stmt.name}: #{included.value}"
+ container.send("add_#{stmt.name}",Include.new(included.value, stmt.doc))
end
end
end
@@ -220,7 +220,7 @@ class Parser
code = klass.code.children if klass.code.is_a?(Puppet::Parser::AST::ASTArray)
code ||= klass.code
unless code.nil?
- scan_for_include(cls, code)
+ scan_for_include_or_require(cls, code)
scan_for_resource(cls, code) if Puppet.settings[:document_all]
end
@@ -241,7 +241,7 @@ class Parser
code = node.code.children if node.code.is_a?(Puppet::Parser::AST::ASTArray)
code ||= node.code
unless code.nil?
- scan_for_include(n, code)
+ scan_for_include_or_require(n, code)
scan_for_vardef(n, code)
scan_for_resource(n, code) if Puppet.settings[:document_all]
end