Module: Aws::Templates::Help::Rdoc

Extended by:
Aws::Templates::Help, Texting
Defined in:
lib/aws/templates/help/rdoc.rb,
lib/aws/templates/help/rdoc/dsl.rb,
lib/aws/templates/help/rdoc/default.rb,
lib/aws/templates/help/rdoc/routing.rb,
lib/aws/templates/help/rdoc/texting.rb,
lib/aws/templates/help/rdoc/artifact.rb,
lib/aws/templates/help/rdoc/provider.rb,
lib/aws/templates/help/rdoc/composite.rb,
lib/aws/templates/help/rdoc/inheritable.rb,
lib/aws/templates/help/rdoc/parametrized.rb,
lib/aws/templates/help/rdoc/contextualized.rb,
lib/aws/templates/help/rdoc/default/provider.rb,
lib/aws/templates/help/rdoc/default/definition.rb,
lib/aws/templates/help/rdoc/parametrized/getter.rb,
lib/aws/templates/help/rdoc/parametrized/nested.rb,
lib/aws/templates/help/rdoc/parametrized/getters.rb,
lib/aws/templates/help/rdoc/contextualized/filter.rb,
lib/aws/templates/help/rdoc/parametrized/provider.rb,
lib/aws/templates/help/rdoc/contextualized/filters.rb,
lib/aws/templates/help/rdoc/parametrized/parameter.rb,
lib/aws/templates/help/rdoc/contextualized/provider.rb,
lib/aws/templates/help/rdoc/parametrized/constraint.rb,
lib/aws/templates/help/rdoc/parametrized/constraints.rb,
lib/aws/templates/help/rdoc/contextualized/filters/add.rb,
lib/aws/templates/help/rdoc/contextualized/filters/copy.rb,
lib/aws/templates/help/rdoc/parametrized/transformation.rb,
lib/aws/templates/help/rdoc/contextualized/filters/chain.rb,
lib/aws/templates/help/rdoc/contextualized/filters/proxy.rb,
lib/aws/templates/help/rdoc/parametrized/transformations.rb,
lib/aws/templates/help/rdoc/contextualized/filters/remove.rb,
lib/aws/templates/help/rdoc/contextualized/filters/scoped.rb,
lib/aws/templates/help/rdoc/parametrized/constraints/enum.rb,
lib/aws/templates/help/rdoc/contextualized/filters/identity.rb,
lib/aws/templates/help/rdoc/contextualized/filters/override.rb,
lib/aws/templates/help/rdoc/parametrized/constraints/all_of.rb,
lib/aws/templates/help/rdoc/parametrized/constraints/matches.rb,
lib/aws/templates/help/rdoc/parametrized/constraints/not_nil.rb,
lib/aws/templates/help/rdoc/parametrized/constraints/requires.rb,
lib/aws/templates/help/rdoc/parametrized/constraints/condition.rb,
lib/aws/templates/help/rdoc/parametrized/transformations/as_hash.rb,
lib/aws/templates/help/rdoc/parametrized/transformations/as_list.rb,
lib/aws/templates/help/rdoc/parametrized/transformations/as_chain.rb,
lib/aws/templates/help/rdoc/parametrized/transformations/as_module.rb,
lib/aws/templates/help/rdoc/parametrized/transformations/as_object.rb,
lib/aws/templates/help/rdoc/parametrized/transformations/as_string.rb,
lib/aws/templates/help/rdoc/parametrized/transformations/as_boolean.rb,
lib/aws/templates/help/rdoc/parametrized/transformations/as_integer.rb,
lib/aws/templates/help/rdoc/parametrized/transformations/as_rendered.rb,
lib/aws/templates/help/rdoc/parametrized/constraints/depends_on_value.rb,
lib/aws/templates/help/rdoc/parametrized/constraints/satisfies_condition.rb,
lib/aws/templates/help/rdoc/contextualized/filters/recursive_schema_filter.rb

Overview

Rdoc-based help generator

The generator uses RDoc utility classes internally to compose documentation blurbs. It supports all output formats as RDoc.

Defined Under Namespace

Modules: Contextualized, Default, Parametrized, Routing, Texting Classes: Artifact, Calculable, Composite, DefaultProvider, Dsl, Inheritable, Provider, Scalar

Class Method Summary collapse

Methods included from Aws::Templates::Help

format, process, show

Methods included from Processor

#define_handler, #handler?, #handler_for, #process, #routing

Methods included from Processor::Routing

#register, #registry

Methods included from Texting

document, list, parsed_for, sub, text

Class Method Details

.format(result, params = nil) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/aws/templates/help/rdoc.rb', line 85

def self.format(result, params = nil)
  formatter = formatter_for(params)

  formatter.start_accepting

  if result
    result = list(:LABEL, result) if result.is_a?(RDoc::Markup::ListItem)
    result.accept(formatter)
  end

  formatter.end_accepting
end

.formatter_for(params) ⇒ Object 



98
99
100
101
 
# File 'lib/aws/templates/help/rdoc.rb', line 98

def self.formatter_for(params)
  return RDoc::Markup::ToAnsi.new unless params && params.include?(:formatter)
  Templates::Utils.lookup_module(params[:formatter]).new
end