Arrow::Template::CommentNode

A comment node object class. Instances of this class are nodes in a syntax tree which represent the invisible markup useful for diagnosis or debugging.

Constants

SVNRev: SVN Revision
SVNId: SVN Id

Public Class Methods

new( body, type='comment' ) click to toggle source

Create a new Arrow::Template::TextNode object with the given body.

     # File /Users/ged/source/ruby/Arrow/lib/arrow/template/nodes.rb, line 263
263:         def initialize( body, type='comment' )
264:             super
265:         end

Public Instance Methods

render( template, scope ) click to toggle source

Render the comment in the context of the specified template and scope.

     # File /Users/ged/source/ruby/Arrow/lib/arrow/template/nodes.rb, line 273
273:         def render( template, scope )
274:             [ template.render_comment( self.to_s ) ]
275:         end

to_html() click to toggle source

Return an HTML fragment that can be used to represent the node symbolically in a web-based introspection interface.

     # File /Users/ged/source/ruby/Arrow/lib/arrow/template/nodes.rb, line 280
280:         def to_html
281:             super { self.escape_html(self.to_s) }
282:         end

secsequence

--- SEC00154

seccomment

--- ""

method_list

--- 
- methods: 
  - visibility: public
    aref: M000476
    name: new
    sourcecode: "     <span class=\"ruby-comment cmt\"># File /Users/ged/source/ruby/Arrow/lib/arrow/template/nodes.rb, line 263</span>\n\
      263:         <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-identifier\">initialize</span>( <span class=\"ruby-identifier\">body</span>, <span class=\"ruby-identifier\">type</span>=<span class=\"ruby-value str\">'comment'</span> )\n\
      264:             <span class=\"ruby-keyword kw\">super</span>\n\
      265:         <span class=\"ruby-keyword kw\">end</span>"
    m_desc: |-
      <p>
      Create a <a href="CommentNode.html#M000476">new</a>
      Arrow::Template::TextNode object with the given <tt>body</tt>.
      </p>
    params: ( body, type='comment' )
  category: Class
  type: Public
- methods: 
  - visibility: public
    aref: M000477
    name: render
    sourcecode: "     <span class=\"ruby-comment cmt\"># File /Users/ged/source/ruby/Arrow/lib/arrow/template/nodes.rb, line 273</span>\n\
      273:         <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-identifier\">render</span>( <span class=\"ruby-identifier\">template</span>, <span class=\"ruby-identifier\">scope</span> )\n\
      274:             [ <span class=\"ruby-identifier\">template</span>.<span class=\"ruby-identifier\">render_comment</span>( <span class=\"ruby-keyword kw\">self</span>.<span class=\"ruby-identifier\">to_s</span> ) ]\n\
      275:         <span class=\"ruby-keyword kw\">end</span>"
    m_desc: |-
      <p>
      Render the comment in the context of the specified <tt>template</tt> and
      <tt>scope</tt>.
      </p>
    params: ( template, scope )
  - visibility: public
    aref: M000478
    name: to_html
    sourcecode: "     <span class=\"ruby-comment cmt\"># File /Users/ged/source/ruby/Arrow/lib/arrow/template/nodes.rb, line 280</span>\n\
      280:         <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-identifier\">to_html</span>\n\
      281:             <span class=\"ruby-keyword kw\">super</span> { <span class=\"ruby-keyword kw\">self</span>.<span class=\"ruby-identifier\">escape_html</span>(<span class=\"ruby-keyword kw\">self</span>.<span class=\"ruby-identifier\">to_s</span>) }\n\
      282:         <span class=\"ruby-keyword kw\">end</span>"
    m_desc: |-
      <p>
      Return an HTML fragment that can be used to represent the node symbolically
      in a web-based introspection interface.
      </p>
    params: ()
  category: Instance
  type: Public

sectitle

---

constants

--- 
- name: SVNRev
  desc: |+
    
    SVN Revision
    
  value: "%q$Rev: 437 $"
- name: SVNId
  desc: |+
    
    SVN Id
    
  value: "%q$Id: nodes.rb 437 2008-03-28 00:49:20Z deveiant $"

In Files

Subversion Info

Parent

Methods

Class Index