Mint::DocumentationGenerator
Inherits Mint::Errorable
This module contains functions for generating JSON compatible API documentation of source code. It uses a unfified sutructure for entities and top-level entities.
It is used in two places currently:
StaticDocumentationGeneratorwhich generates HTML documentation- On the website which consumes JSON to display the documentation
Instance methods
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)
Sourcegenerate(node : Ast::TypeDefinitionField)
Sourcegenerate(node : Ast::TypeVariant)
Sourcegenerate(node : Ast::Property)
Sourcegenerate(node : Ast::Constant)
Sourcegenerate(node : Ast::Function)
Sourcegenerate(node : Ast::Signal)
Sourcegenerate(node : Ast::State)
Sourcegenerate(node : Ast::Get)
Sourcegenerate(node : Ast::Node)
Sourcegenerate(node : Nil) : Nil
Sourcehighlight(node : Nil)
Sourcehighlight(node : Ast::Node)
Sourcemarkdown(node : Ast::Comment | Nil)
Sourceresolve(node : Ast::Component) : TopLevelEntity
Sourceresolve(node : Ast::Store) : TopLevelEntity
Sourceresolve(node : Ast::Provider) : TopLevelEntity
Sourceresolve(node : Ast::Module) : TopLevelEntity
Sourceresolve(node : Ast::TypeDefinition) : TopLevelEntity
Sourceresolve(node : Ast::Node)
Source