Class: Brandish::Processors::All::Comment

Inherits:

Brandish::Processor::Base

• Object
• Brandish::Processor::Base
• Brandish::Processors::All::Comment

Includes:

Brandish::Processor::Block

Defined in:

lib/brandish/processors/all/comment.rb

Overview

Adds a <comment> tag. This ignores all of the elements inside of it, effectively removing it from the output.

This processor takes no options, nor any pairs.

Examples:

Congratulations!  You've won $1,000!
<comment>Before taxes, anyway.</comment>

Instance Attribute Summary

Attributes inherited from Brandish::Processor::Base

#context

Instance Method Summary

• #process ⇒ nil

  Returns nil, removing the node and its children from the tree.

Methods included from Brandish::Processor::Block

included, #perform, #process_block

Methods inherited from Brandish::Processor::Base

#accept, #call, #initialize, #postprocess, #process_block, #process_command, #process_root, #process_text, register, #setup

Constructor Details

This class inherits a constructor from Brandish::Processor::Base

Instance Method Details

#process ⇒ nil

Returns nil, removing the node and its children from the tree.

Returns:

• (nil)

# File 'lib/brandish/processors/all/comment.rb', line 23

def process
  nil
end