Class: RDoc::PuppetModule

Inherits:
NormalModule
  • Object
show all
Defined in:
lib/puppet/util/rdoc/code_objects.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, superclass = nil) ⇒ PuppetModule

Returns a new instance of PuppetModule.



40
41
42
43
44
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 40

def initialize(name,superclass=nil)
  @facts = []
  @plugins = []
  super(name,superclass)
end

Instance Attribute Details

#facts ⇒ Object

Returns the value of attribute facts.



38
39
40
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 38

def facts
  @facts
end

#plugins ⇒ Object

Returns the value of attribute plugins.



38
39
40
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 38

def plugins
  @plugins
end

Instance Method Details

#add_fact(fact) ⇒ Object 



55
56
57
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 55

def add_fact(fact)
  add_to(@facts, fact)
end

#add_node(name, superclass) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 59

def add_node(name,superclass)
  cls = @nodes[name]
  unless cls
    cls = PuppetNode.new(name, superclass)
    @nodes[name] = cls if !@done_documenting
    cls.parent = self
    cls.section = @current_section
  end
  cls
end

#add_plugin(plugin) ⇒ Object 



51
52
53
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 51

def add_plugin(plugin)
  add_to(@plugins, plugin)
end

#each_fact ⇒ Object 



70
71
72
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 70

def each_fact
  @facts.each {|c| yield c}
end

#each_node ⇒ Object 



78
79
80
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 78

def each_node
  @nodes.each {|c| yield c}
end

#each_plugin ⇒ Object 



74
75
76
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 74

def each_plugin
  @plugins.each {|c| yield c}
end

#initialize_classes_and_modules ⇒ Object 



46
47
48
49
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 46

def initialize_classes_and_modules
  super
  @nodes = {}
end

#nodes ⇒ Object 



82
83
84
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 82

def nodes
  @nodes.values
end