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
32 def initialize(name,superclass=nil)
33   @facts = []
34   @plugins = []
35   @nodes = {}
36   super(name,superclass)
37 end

Public Instance Methods

add_fact(fact) click to toggle source
   # File lib/puppet/util/rdoc/code_objects.rb
57 def add_fact(fact)
58   @fact_container ||= add_module(NormalModule, "__facts__")
59   confine_str = fact.confine.empty? ? '' : fact.confine.to_s
60   const = Constant.new(fact.name, confine_str, fact.comment)
61   @fact_container.add_constant(const)
62 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
66 def add_node(name,superclass)
67   cls = @nodes[name]
68   if cls
69     return cls
70   end
71   @node_container ||= add_module(NormalModule, "__nodes__")
72   cls = @node_container.add_class(PuppetNode, name, superclass)
73   @nodes[name] = cls if !@done_documenting
74   cls
75 end
add_plugin(plugin) click to toggle source
   # File lib/puppet/util/rdoc/code_objects.rb
39 def add_plugin(plugin)
40   name = plugin.name
41   type = plugin.type
42   meth = AnyMethod.new("*args", name)
43   meth.params = "(*args)"
44   meth.visibility = :public
45   meth.document_self = true
46   meth.singleton = false
47   meth.comment = plugin.comment
48   if type == 'function'
49     @function_container ||= add_module(NormalModule, "__functions__")
50     @function_container.add_method(meth)
51   elsif type == 'type'
52     @type_container ||= add_module(NormalModule, "__types__")
53     @type_container.add_method(meth)
54   end
55 end
each_fact() { |c| ... } click to toggle source
   # File lib/puppet/util/rdoc/code_objects.rb
77 def each_fact
78   @facts.each {|c| yield c}
79 end
each_node() { |c| ... } click to toggle source
   # File lib/puppet/util/rdoc/code_objects.rb
85 def each_node
86   @nodes.each {|c| yield c}
87 end
each_plugin() { |c| ... } click to toggle source
   # File lib/puppet/util/rdoc/code_objects.rb
81 def each_plugin
82   @plugins.each {|c| yield c}
83 end
nodes() click to toggle source
   # File lib/puppet/util/rdoc/code_objects.rb
89 def nodes
90   @nodes.values
91 end