class Docr::Formatters::Default

• Docr::Formatters::Default
• Reference
• Object

Included Modules

• Docr::Formatters::Base

Defined in:

formatters/default/info.cr
formatters/default/signature.cr
formatters/default/tree.cr

Class Method Summary

• .format_path(path : String, color : Colorize::ColorANSI) : String
• .info(io : IO, type : Redoc::Const) : Nil
• .info(io : IO, type : Redoc::Module) : Nil
• .info(io : IO, type : Redoc::Class) : Nil
• .info(io : IO, type : Redoc::Struct) : Nil
• .info(io : IO, type : Redoc::Alias) : Nil
• .info(io : IO, type : Redoc::Annotation) : Nil
• .info(io : IO, type : Redoc::Enum) : Nil
• .info(io : IO, type : Redoc::Def) : Nil
• .info(io : IO, type : Redoc::Macro) : Nil
• .signature(io : IO, type : Redoc::Const, full : Bool, with_value : Bool) : Nil
• .signature(io : IO, type : Redoc::Module, full : Bool, with_parent : Bool) : Nil
• .signature(io : IO, type : Redoc::Class, full : Bool, with_parent : Bool) : Nil
• .signature(io : IO, type : Redoc::Struct, full : Bool, with_parent : Bool) : Nil
• .signature(io : IO, type : Redoc::Enum, full : Bool, with_base : Bool) : Nil
• .signature(io : IO, type : Redoc::Alias, full : Bool, with_value : Bool) : Nil
• .signature(io : IO, type : Redoc::Annotation, full : Bool, __) : Nil
• .signature(io : IO, type : Redoc::Def, with_parent : Bool, with_self : Bool) : Nil
• .signature(io : IO, type : Redoc::Macro, with_parent : Bool, __) : Nil
• .tree(io : IO, type : Redoc::Library | Redoc::Type, includes : Array(String), locations : Bool) : Nil

Instance Method Summary

• #format(type : Redoc::Library) : Nil
• #format(type : Redoc::Const) : Nil
• #format(type : Redoc::Module) : Nil
• #format(type : Redoc::Class) : Nil
• #format(type : Redoc::Struct) : Nil
• #format(type : Redoc::Enum) : Nil
• #format(type : Redoc::Alias) : Nil
• #format(type : Redoc::Annotation) : Nil
• #format(type : Redoc::Def, with_self : Bool = false) : Nil
• #format(type : Redoc::Macro) : Nil

Class Method Detail

Instance Method Detail