File: C:/Ruby27-x64/share/doc/ruby/html/REXML/Comment.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class REXML::Comment - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="Child.html">REXML::Child</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../Comparable.html">Comparable</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-3C-3D-3E">#<=></a>
<li ><a href="#method-i-3D-3D">#==</a>
<li ><a href="#method-i-clone">#clone</a>
<li ><a href="#method-i-node_type">#node_type</a>
<li ><a href="#method-i-write">#write</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-REXML::Comment">
<h1 id="class-REXML::Comment" class="class">
class REXML::Comment
</h1>
<section class="description">
<p>Represents an <a href="../XML.html"><code>XML</code></a> comment; that is, text between <!– … –></p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="START">START
<dd>
<dt id="STOP">STOP
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-string" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">string</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The content text</p>
</div>
</div>
<div id="attribute-i-to_s" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">to_s</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The content text</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">( first, second = nil )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Constructor. The first argument can be one of three types: @param first If <a href="../String.html"><code>String</code></a>, the contents of this comment are set to the argument. If <a href="Comment.html"><code>Comment</code></a>, the argument is duplicated. If <a href="Source.html"><code>Source</code></a>, the argument is scanned for a comment. @param second If the first argument is a <a href="Source.html"><code>Source</code></a>, this argument should be nil, not supplied, or a <a href="Parent.html"><code>Parent</code></a> to be set as the parent of this object</p>
<div class="method-calls-super">
Calls superclass method
<a href="Child.html#method-c-new"><code>REXML::Child::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rexml/comment.rb, line 24</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>( <span class="ruby-identifier">first</span>, <span class="ruby-identifier">second</span> = <span class="ruby-keyword">nil</span> )
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">second</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">first</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">String</span>
<span class="ruby-ivar">@string</span> = <span class="ruby-identifier">first</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">first</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Comment</span>
<span class="ruby-ivar">@string</span> = <span class="ruby-identifier">first</span>.<span class="ruby-identifier">string</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-3C-3D-3E" class="method-detail ">
<div class="method-heading">
<span class="method-name"><=></span><span
class="method-args">(other)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Compares this <a href="Comment.html"><code>Comment</code></a> to another; the contents of the comment are used in the comparison.</p>
<div class="method-source-code" id="3C-3D-3E-source">
<pre><span class="ruby-comment"># File lib/rexml/comment.rb, line 63</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><=></span>(<span class="ruby-identifier">other</span>)
<span class="ruby-identifier">other</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator"><=></span> <span class="ruby-ivar">@string</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-3D-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">==</span><span
class="method-args">( other )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Compares this <a href="Comment.html"><code>Comment</code></a> to another; the contents of the comment are used in the comparison.</p>
<div class="method-source-code" id="3D-3D-source">
<pre><span class="ruby-comment"># File lib/rexml/comment.rb, line 70</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">==</span>( <span class="ruby-identifier">other</span> )
<span class="ruby-identifier">other</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Comment</span> <span class="ruby-keyword">and</span>
(<span class="ruby-identifier">other</span> <span class="ruby-operator"><=></span> <span class="ruby-keyword">self</span>) <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-clone" class="method-detail ">
<div class="method-heading">
<span class="method-name">clone</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="clone-source">
<pre><span class="ruby-comment"># File lib/rexml/comment.rb, line 33</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clone</span>
<span class="ruby-constant">Comment</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-node_type" class="method-detail ">
<div class="method-heading">
<span class="method-name">node_type</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="node_type-source">
<pre><span class="ruby-comment"># File lib/rexml/comment.rb, line 75</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">node_type</span>
<span class="ruby-value">:comment</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write" class="method-detail ">
<div class="method-heading">
<span class="method-name">write</span><span
class="method-args">( output, indent=-1, transitive=false, ie_hack=false )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<h2 id="method-i-write-label-DEPRECATED">DEPRECATED<span><a href="#method-i-write-label-DEPRECATED">¶</a> <a href="#top">↑</a></span></h2>
<p>See <a href="Formatters.html"><code>REXML::Formatters</code></a></p>
<dl class="rdoc-list note-list"><dt>output
<dd>
<p>Where to write the string</p>
</dd><dt>indent
<dd>
<p>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.</p>
</dd><dt>transitive
<dd>
<p>Ignored by this class. The contents of comments are never modified.</p>
</dd><dt>ie_hack
<dd>
<p>Needed for conformity to the child API, but not used by this class.</p>
</dd></dl>
<div class="method-source-code" id="write-source">
<pre><span class="ruby-comment"># File lib/rexml/comment.rb, line 50</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>( <span class="ruby-identifier">output</span>, <span class="ruby-identifier">indent</span>=<span class="ruby-value">-1</span>, <span class="ruby-identifier">transitive</span>=<span class="ruby-keyword">false</span>, <span class="ruby-identifier">ie_hack</span>=<span class="ruby-keyword">false</span> )
<span class="ruby-constant">Kernel</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-string">"Comment.write is deprecated. See REXML::Formatters"</span>, <span class="ruby-value">uplevel:</span> <span class="ruby-value">1</span>)
<span class="ruby-identifier">indent</span>( <span class="ruby-identifier">output</span>, <span class="ruby-identifier">indent</span> )
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">START</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@string</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">STOP</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>