module Mint::DocumentationGenerator

Overview

This module contains funcions for generating JSON compatible API documentation of souce code. It uses a unfified sutructure for entities and top-level entities.

It is used in two places currently:

• StaticDocumentationGenerator which generates HTML documentation
• On the website which consumes JSON to display the documentation

Included Modules

• Mint::Errorable

Extended Modules

• Mint::DocumentationGenerator

Defined in:

documentation_generator.cr

Instance Method Summary

• #entity(*, arguments : Array(Argument) | Nil = nil, description : Ast::Comment | Nil = nil, value : Ast::Node | Nil = nil, mapping : String | Nil = nil, type : Ast::Node | Nil = nil, name : String, kind : Kind)
• #generate(node : Ast::TypeDefinitionField)
• #generate(node : Ast::TypeVariant)
• #generate(node : Ast::Property)
• #generate(node : Ast::Constant)
• #generate(node : Ast::Function)
• #generate(node : Ast::Signal)
• #generate(node : Ast::State)
• #generate(node : Ast::Get)
• #generate(node : Ast::Node)
• #generate(nodes : Array(Ast::Node))
• #generate(node : Nil) : Nil
• #highlight(formatted : String)
• #highlight(node : Nil)
• #highlight(node : Ast::Node)
• #markdown(node : Ast::Comment | Nil)
• #resolve(node : Ast::Component) : TopLevelEntity
• #resolve(node : Ast::Store) : TopLevelEntity
• #resolve(node : Ast::Provider) : TopLevelEntity
• #resolve(node : Ast::Module) : TopLevelEntity
• #resolve(node : Ast::TypeDefinition) : TopLevelEntity
• #resolve(node : Ast::Node)
• #resolve(ast : Ast) : Array(TopLevelEntity)

Instance Method Detail