Class: Aws::Templates::Help::Rdoc::Contextualized::Filters::RecursiveSchemaFilter

Inherits:
Aws::Templates::Help::Rdoc::Contextualized::Filter show all
Defined in:
lib/aws/templates/help/rdoc/contextualized/filters/recursive_schema_filter.rb

Overview

Common class for schema-based filters

Outputs schema object with specified blurb as the header.

Direct Known Subclasses

Add, Remove

Instance Attribute Summary

Attributes inherited from Processor::Handler

#context, #parameters

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Texting

#document, #list, #parsed_for, #sub, #text

Methods inherited from Processor::Handler

for_entity, #handler_for, #in_context, #initialize, #processed_for, processor, #processor, register_in

Constructor Details

This class inherits a constructor from Aws::Templates::Processor::Handler

Class Method Details

.blurb(str = nil) ⇒ Object



14
15
16
17
# File 'lib/aws/templates/help/rdoc/contextualized/filters/recursive_schema_filter.rb', line 14

def self.blurb(str = nil)
  return @description_blurb if str.nil?
  @description_blurb = str
end

Instance Method Details

#provideObject



19
20
21
# File 'lib/aws/templates/help/rdoc/contextualized/filters/recursive_schema_filter.rb', line 19

def provide
  sub(text(self.class.blurb), processed_for(context.scheme))
end