class RDoc::PuppetModule

PuppetModule holds a Puppet Module This is mapped to an HTMLPuppetModule it leverage the RDoc (ruby) module infrastructure

Attributes

facts[RW]

plugins[RW]

Public Class Methods

new(name,superclass=nil) click to toggle source

Calls superclass method

   # File lib/puppet/util/rdoc/code_objects.rb
33 def initialize(name,superclass=nil)
34   @facts = []
35   @plugins = []
36   @nodes = {}
37   super(name,superclass)
38 end

Public Instance Methods

add_fact(fact) click to toggle source

   # File lib/puppet/util/rdoc/code_objects.rb
58 def add_fact(fact)
59   @fact_container ||= add_module(NormalModule, "__facts__")
60   confine_str = fact.confine.empty? ? '' : fact.confine.to_s
61   const = Constant.new(fact.name, confine_str, fact.comment)
62   @fact_container.add_constant(const)
63 end

add_node(name,superclass) click to toggle source

Adds a module called __nodes__ and adds nodes to it as classes

   # File lib/puppet/util/rdoc/code_objects.rb
67 def add_node(name,superclass)
68   cls = @nodes[name]
69   if cls
70     return cls
71   end
72   @node_container ||= add_module(NormalModule, "__nodes__")
73   cls = @node_container.add_class(PuppetNode, name, superclass)
74   @nodes[name] = cls if !@done_documenting
75   cls
76 end

add_plugin(plugin) click to toggle source

   # File lib/puppet/util/rdoc/code_objects.rb
40 def add_plugin(plugin)
41   name = plugin.name
42   type = plugin.type
43   meth = AnyMethod.new("*args", name)
44   meth.params = "(*args)"
45   meth.visibility = :public
46   meth.document_self = true
47   meth.singleton = false
48   meth.comment = plugin.comment
49   if type == 'function'
50     @function_container ||= add_module(NormalModule, "__functions__")
51     @function_container.add_method(meth)
52   elsif type == 'type'
53     @type_container ||= add_module(NormalModule, "__types__")
54     @type_container.add_method(meth)
55   end
56 end

each_fact() { |c| ... } click to toggle source

   # File lib/puppet/util/rdoc/code_objects.rb
78 def each_fact
79   @facts.each {|c| yield c}
80 end

each_node() { |c| ... } click to toggle source

   # File lib/puppet/util/rdoc/code_objects.rb
86 def each_node
87   @nodes.each {|c| yield c}
88 end

each_plugin() { |c| ... } click to toggle source

   # File lib/puppet/util/rdoc/code_objects.rb
82 def each_plugin
83   @plugins.each {|c| yield c}
84 end

nodes() click to toggle source

   # File lib/puppet/util/rdoc/code_objects.rb
90 def nodes
91   @nodes.values
92 end