Class

REXML::Comment

In:

Parent:

Child

Represents an XML comment; that is, text between <!— … —>

Methods

<=> == clone new node_type write

Included Modules

Comparable

Constants

START	=	"<!--"
STOP	=	"-->"

External Aliases

string -> to_s

Attributes

string [RW]

Public Class methods

new( first, second = nil )

Constructor. The first argument can be one of three types: @param first If String, the contents of this comment are set to the argument. If Comment, the argument is duplicated. If Source, the argument is scanned for a comment. @param second If the first argument is a Source, this argument should be nil, not supplied, or a Parent to be set as the parent of this object

[Source]

21:                 def initialize( first, second = nil )
22:                         #puts "IN COMMENT CONSTRUCTOR; SECOND IS #{second.type}"
23:                         super(second)
24:                         if first.kind_of? String
25:                                 @string = first
26:                         elsif first.kind_of? Comment
27:                                 @string = first.string
28:                         end
29:                 end

Public Instance methods

<=>(other)

Compares this Comment to another; the contents of the comment are used in the comparison.

[Source]

69:                 def <=>(other)
70:                         other.to_s <=> @string
71:                 end

==( other )

Compares this Comment to another; the contents of the comment are used in the comparison.

[Source]

76:                 def ==( other )
77:                         other.kind_of? Comment and
78:                         (other <=> self) == 0
79:                 end

clone()

[Source]

31:                 def clone
32:                         Comment.new self
33:                 end

node_type()

[Source]

81:     def node_type
82:       :comment
83:     end

write( output, indent=-1, transitive=false, ie_hack=false )

output:	Where to write the string
indent:	An integer. If -1, no indenting will be used; otherwise, the indentation will be this number of spaces, and children will be indented an additional amount.
transitive:	If transitive is true and indent is >= 0, then the output will be pretty-printed in such a way that the added whitespace does not affect the absolute value of the document — that is, it leaves the value and number of Text nodes in the document unchanged.
ie_hack:	Internet Explorer is the worst piece of crap to have ever been written, with the possible exception of Windows itself. Since IE is unable to parse proper XML, we have to provide a hack to generate XML that IE’s limited abilities can handle. This hack inserts a space before the /> on empty tags.

[Source]

53:                 def write( output, indent=-1, transitive=false, ie_hack=false )
54:                         indent( output, indent )
55:                         output << START
56:                         output << @string
57:       if indent>-1
58:         output << "\n"
59:         indent( output, indent )
60:       end
61:                         output << STOP
62:                 end

[Validate]

Ruby-Language API Docs and Resources

Methods

Included Modules

Constants

External Aliases

Attributes

Public Class methods

Public Instance methods

Search

Ruby API Docs

Links