summaryrefslogtreecommitdiffstats
path: root/lib/puppet/util/rdoc/code_objects.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/code_objects.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/code_objects.rb')
-rw-r--r--lib/puppet/util/rdoc/code_objects.rb10
1 files changed, 9 insertions, 1 deletions
diff --git a/lib/puppet/util/rdoc/code_objects.rb b/lib/puppet/util/rdoc/code_objects.rb
index 6e384e1ea..056f376c6 100644
--- a/lib/puppet/util/rdoc/code_objects.rb
+++ b/lib/puppet/util/rdoc/code_objects.rb
@@ -88,11 +88,12 @@ module RDoc
# It is mapped to a HTMLPuppetClass for display
# It leverages RDoc (ruby) Class
class PuppetClass < ClassModule
- attr_accessor :resource_list
+ attr_accessor :resource_list, :requires
def initialize(name, superclass)
super(name,superclass)
@resource_list = []
+ @requires = []
end
def add_resource(resource)
@@ -106,6 +107,13 @@ module RDoc
def superclass=(superclass)
@superclass = superclass
end
+
+ # we're (ab)using the RDoc require system here.
+ # we're adding a required Puppet class, overriding
+ # the RDoc add_require method which sees ruby required files.
+ def add_require(required)
+ add_to(@requires, required)
+ end
end
# PuppetNode holds a puppet node