Class: RDoc::Fact

Inherits:

Context

• Object
• Context
• RDoc::Fact

Defined in:

lib/puppet/util/rdoc/code_objects.rb

Overview

Fact holds a custom fact It is mapped to a HTMLPuppetPlugin for display

Instance Attribute Summary

• #confine ⇒ Object

  Returns the value of attribute confine.

• #name ⇒ Object

  Returns the value of attribute name.

Instance Method Summary

• #<=>(other) ⇒ Object
• #full_name ⇒ Object
• #initialize(name, confine) ⇒ Fact constructor

  A new instance of Fact.

• #is_fact? ⇒ Boolean
• #to_s ⇒ Object

Constructor Details

#initialize(name, confine) ⇒ Fact

# File 'lib/puppet/util/rdoc/code_objects.rb', line 237

def initialize(name, confine)
  super()
  @name = name
  @confine = confine
  @comment = ""
end

Instance Attribute Details

#confine ⇒ Object

Returns the value of attribute confine

# File 'lib/puppet/util/rdoc/code_objects.rb', line 235

def confine
  @confine
end

#name ⇒ Object

Returns the value of attribute name

# File 'lib/puppet/util/rdoc/code_objects.rb', line 235

def name
  @name
end

Instance Method Details

#<=>(other) ⇒ Object

# File 'lib/puppet/util/rdoc/code_objects.rb', line 244

def <=>(other)
  @name <=> other.name
end

#full_name ⇒ Object

# File 'lib/puppet/util/rdoc/code_objects.rb', line 252

def full_name
  @name
end

#is_fact? ⇒ Boolean

# File 'lib/puppet/util/rdoc/code_objects.rb', line 248

def is_fact?
  true
end

#to_s ⇒ Object

# File 'lib/puppet/util/rdoc/code_objects.rb', line 256

def to_s
  res = self.class.name + ": #{@name}\n"
  res << @comment.to_s
  res
end