Class

REXML::Comment

Inheritance
< REXML::Child < Object
Included Modules
Comparable

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

Constants

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

Attributes

Name Visibility R/W Description
string public RW The content text

Aliases

Method Alias Description
string → to_s

Methods

Class

Visibility Signature
public new ( first, second = nil )

Instance

Visibility Signature
public <=> (other)
public == ( other )
public clone ()
public node_type ()
public write ( output, indent=-1, transitive=false, ie_hack=false )

Class Method Detail

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

Instance Method Detail

<=>(other)

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

==( other )

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

clone()

node_type()

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

DEPRECATED

See REXML::Formatters

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:Ignored by this class. The contents of comments are never modified.
ie_hack:Needed for conformity to the child API, but not used by this class.