class Aws::Templates::Help::Rdoc::Parametrized::Parameter

Parameter documentation provider

Combines parameter description and documentation blocks for constraint, getter and transformation if they are assigned to the parameter.

Public Instance Methods

provide() click to toggle source
# File lib/aws/templates/help/rdoc/parametrized/parameter.rb, line 16
def provide
  sub(description) do |s|
    s << list(:BULLET) do |l|
      add_transformation(l)
      add_constraint(l)
    end
  end
end

Private Instance Methods

add_constraint(l) click to toggle source
# File lib/aws/templates/help/rdoc/parametrized/parameter.rb, line 42
def add_constraint(l)
  return unless context.constraint

  l << sub(
    text('constraint:'),
    processed_for(context.constraint)
  )
end
add_transformation(l) click to toggle source
# File lib/aws/templates/help/rdoc/parametrized/parameter.rb, line 33
def add_transformation(l)
  return unless context.transform

  l << sub(
    text('transformation:'),
    processed_for(context.transform)
  )
end
description() click to toggle source
# File lib/aws/templates/help/rdoc/parametrized/parameter.rb, line 27
def description
  desc = "_#{context.name}_ "
  desc.concat(context.description) if context.description
  text(desc)
end