Class: RDoc::PuppetResource

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

Overview

PuppetResource holds a puppet resource It is mapped to a HTMLPuppetResource for display A resource is defined by its “normal” form Type

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type, title, comment, params) ⇒ PuppetResource

Returns a new instance of PuppetResource.


269
270
271
272
273
274
275
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 269

def initialize(type, title, comment, params)
  super()
  @type = type
  @title = title
  @comment = comment
  @params = params
end

Instance Attribute Details

#params ⇒ Object

Returns the value of attribute params


267
268
269
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 267

def params
  @params
end

#title ⇒ Object

Returns the value of attribute title


267
268
269
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 267

def title
  @title
end

#type ⇒ Object

Returns the value of attribute type


267
268
269
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 267

def type
  @type
end

Instance Method Details

#<=>(other) ⇒ Object 


277
278
279
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 277

def <=>(other)
  full_name <=> other.full_name
end

#full_name ⇒ Object 


281
282
283
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 281

def full_name
  @type + "[#{@title}]"
end

#name ⇒ Object 


285
286
287
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 285

def name
  full_name
end

#to_s ⇒ Object 


289
290
291
292
293
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 289

def to_s
  res = @type + "[#{@title}]\n"
  res << @comment.to_s
  res
end