module Aws::Templates::Help::Rdoc

Rdoc-based help generator

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

Public Class Methods

format(result, params = nil) click to toggle source
# 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) click to toggle source
# 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