<!DOCTYPE html>
<html> <head> <meta charset=“UTF-8”>
<title>class ReVIEW::TOCParser::Section - review-2.2.0 Documentation</title>
<script type=“text/javascript”>
var rdoc_rel_prefix = "../../"; var index_rel_prefix = "../../";
</script>
<script src=“../../js/jquery.js”></script> <script src=“../../js/darkfish.js”></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="Node.html">ReVIEW::TOCParser::Node</a>
</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-estimated_lines">#estimated_lines</a> <li ><a href="#method-i-inspect">#inspect</a> <li ><a href="#method-i-real_filename">#real_filename</a> <li ><a href="#method-i-yield_section">#yield_section</a> </ul>
</div>
</div>
</nav>
<main role=“main” aria-labelledby=“class-ReVIEW::TOCParser::Section”>
<h1 id="class-ReVIEW::TOCParser::Section" class="class"> class ReVIEW::TOCParser::Section </h1> <section class="description"> </section> <section id="5Buntitled-5D" class="documentation-section"> <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> <div id="attribute-i-label" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">label</span><span class="attribute-access-type">[R]</span> </div> <div class="method-description"> </div> </div> <div id="attribute-i-level" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">level</span><span class="attribute-access-type">[R]</span> </div> <div class="method-description"> </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">(level, label, path = nil)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-calls-super"> Calls superclass method <a href="Node.html#method-c-new">ReVIEW::TOCParser::Node.new</a> </div> <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/review/tocparser.rb, line 175</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>initialize</span>(<span class=“ruby-identifier”>level</span>, <span class=“ruby-identifier”>label</span>, <span class=“ruby-identifier”>path</span> = <span class=“ruby-keyword”>nil</span>)
<span class="ruby-keyword">super</span>() <span class="ruby-ivar">@level</span> = <span class="ruby-identifier">level</span> <span class="ruby-ivar">@label</span> = <span class="ruby-identifier">label</span> <span class="ruby-ivar">@filename</span> = (<span class="ruby-identifier">path</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">real_filename</span>(<span class="ruby-identifier">path</span>) <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</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-estimated_lines" class="method-detail "> <div class="method-heading"> <span class="method-name">estimated_lines</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="estimated_lines-source"> <pre><span class="ruby-comment"># File lib/review/tocparser.rb, line 194</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>estimated_lines</span>
<span class="ruby-ivar">@children</span>.<span class="ruby-identifier">inject</span>(<span class="ruby-value">0</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">sum</span>, <span class="ruby-identifier">n</span><span class="ruby-operator">|</span> <span class="ruby-identifier">sum</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">n</span>.<span class="ruby-identifier">estimated_lines</span> }
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-inspect" class="method-detail "> <div class="method-heading"> <span class="method-name">inspect</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="inspect-source"> <pre><span class="ruby-comment"># File lib/review/tocparser.rb, line 202</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>inspect</span>
<span class="ruby-node">"\#<#{self.class} level=#{@level} #{@label}>"</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-yield_section" class="method-detail "> <div class="method-heading"> <span class="method-name">yield_section</span><span class="method-args">() { |self| ... }</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="yield_section-source"> <pre><span class="ruby-comment"># File lib/review/tocparser.rb, line 198</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>yield_section</span>
<span class="ruby-keyword">yield</span> <span class="ruby-keyword">self</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> </section> <section id="private-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Private Instance Methods</h3> </header> <div id="method-i-real_filename" class="method-detail "> <div class="method-heading"> <span class="method-name">real_filename</span><span class="method-args">(path)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="real_filename-source"> <pre><span class="ruby-comment"># File lib/review/tocparser.rb, line 182</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>real_filename</span>(<span class=“ruby-identifier”>path</span>)
<span class="ruby-keyword">if</span> <span class="ruby-constant">FileTest</span>.<span class="ruby-identifier">symlink?</span>(<span class="ruby-identifier">path</span>) <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">readlink</span>(<span class="ruby-identifier">path</span>)) <span class="ruby-keyword">else</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">path</span>) <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> </section> </section>
</main>
<footer id=“validator-badges” role=“contentinfo”>
<p><a href="http://validator.w3.org/check/referer">Validate</a> <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.1.0. <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>