Class: Jdoc::Generator

Inherits:

Object

• Object
• Jdoc::Generator

Defined in:

lib/jdoc/generator.rb

Constant Summary

TEMPLATE_PATH =

File.expand_path("../../../template.md.erb", __FILE__)

Class Method Summary

• .call(*args) ⇒ String

  Utility wrapper for Jdoc::Generator#call.

Instance Method Summary

• #call ⇒ String

  Generates documentation in Markdown format from JSON schema.

• #initialize(schema) ⇒ Generator constructor

  A new instance of Generator.

Constructor Details

#initialize(schema) ⇒ Generator

Returns a new instance of Generator.

Parameters:

• schema (Hash) —

  JSON Schema represented as a Hash

# File 'lib/jdoc/generator.rb', line 12

def initialize(schema)
  @raw_schema = schema
end

Class Method Details

.call(*args) ⇒ String

Utility wrapper for Jdoc::Generator#call

Returns:

• (String)

# File 'lib/jdoc/generator.rb', line 7

def self.call(*args)
  new(*args).call
end

Instance Method Details

#call ⇒ String

Generates documentation in Markdown format from JSON schema

Returns:

• (String) —

  Text of generated markdown document

# File 'lib/jdoc/generator.rb', line 18

def call
  eruby.result(context)
end