class RDoc::Plugin

Plugin holds a native puppet plugin (function,type…) It is mapped to a HTMLPuppetPlugin for display

Attributes

name[RW]

type[RW]

Public Class Methods

new(name, type) click to toggle source

Calls superclass method

    # File lib/puppet/util/rdoc/code_objects.rb
202 def initialize(name, type)
203   super()
204   @name = name
205   @type = type
206   @comment = ""
207 end

Public Instance Methods

<=>(other) click to toggle source

    # File lib/puppet/util/rdoc/code_objects.rb
209 def <=>(other)
210   @name <=> other.name
211 end

full_name() click to toggle source

    # File lib/puppet/util/rdoc/code_objects.rb
213 def full_name
214   @name
215 end

http_url(prefix) click to toggle source

    # File lib/puppet/util/rdoc/code_objects.rb
217 def http_url(prefix)
218   path = full_name.split("::")
219   File.join(prefix, *path) + ".html"
220 end

is_fact?() click to toggle source

    # File lib/puppet/util/rdoc/code_objects.rb
222 def is_fact?
223   false
224 end

to_s() click to toggle source

    # File lib/puppet/util/rdoc/code_objects.rb
226 def to_s
227   res = self.class.name + ": #{@name} (#{@type})\n"
228   res << @comment.to_s
229   res
230 end