class Crystal::Doc::Generator

Defined in:

compiler/crystal/tools/doc/generator.cr

Constant Summary

FLAG_COLORS = {"BUG" => "red", "DEPRECATED" => "red", "WARNING" => "yellow", "EXPERIMENTAL" => "lime", "FIXME" => "yellow", "NOTE" => "purple", "OPTIMIZE" => "green", "TODO" => "orange"}

Adding a flag and associated css class will add support in parser

FLAGS = FLAG_COLORS.keys

Constructors

Instance Method Summary

Instance methods inherited from class Reference

==(other : self)
==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, initialize initialize, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference) : Bool
same?(other : Nil) same?, to_s(io : IO) : Nil to_s

Constructor methods inherited from class Reference

new new, unsafe_construct(address : Pointer, *args, **opts) : self unsafe_construct

Class methods inherited from class Reference

pre_initialize(address : Pointer) pre_initialize

Instance methods inherited from class Object

! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other) ===, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash(hasher)
hash hash, in?(collection : Object) : Bool
in?(*values : Object) : Bool in?, inspect(io : IO) : Nil
inspect : String inspect, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil!(message)
not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO) : Nil
to_json : String to_json, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil to_pretty_json, to_s(io : IO) : Nil
to_s : String to_s, to_yaml(io : IO) : Nil
to_yaml : String to_yaml, try(&) try, unsafe_as(type : T.class) forall T unsafe_as

Class methods inherited from class Object

from_json(string_or_io : String | IO, root : String)
from_json(string_or_io : String | IO) from_json, from_yaml(string_or_io : String | IO) from_yaml

Macros inherited from class Object

class_getter(*names, &block) class_getter, class_getter!(*names) class_getter!, class_getter?(*names, &block) class_getter?, class_property(*names, &block) class_property, class_property!(*names) class_property!, class_property?(*names, &block) class_property?, class_setter(*names) class_setter, def_clone def_clone, def_equals(*fields) def_equals, def_equals_and_hash(*fields) def_equals_and_hash, def_hash(*fields) def_hash, delegate(*methods, to object) delegate, forward_missing_to(delegate) forward_missing_to, getter(*names, &block) getter, getter!(*names) getter!, getter?(*names, &block) getter?, property(*names, &block) property, property!(*names) property!, property?(*names, &block) property?, setter(*names) setter

Constructor Detail

def self.new(program : Program, included_dirs : Array(String), output_dir : String, output_format : String, sitemap_base_url : String | Nil, sitemap_priority : String, sitemap_changefreq : String, project_info : ProjectInfo) #

[View source]
def self.new(program : Program, included_dirs : Array(String)) #

[View source]

Instance Method Detail

def build_flag_lines_from_annotations(context) #

[View source]
def collect_constants(parent) #

[View source]
def collect_subtypes(parent) #

[View source]
def copy_files #

[View source]
def crystal_builtin?(type) #

[View source]
def doc(context, string) #

[View source]
def doc(obj : Type | Method | Macro | Constant) #

[View source]
def fetch_doc_lines(doc : String) : String #

[View source]
def generate_docs_html(program_type, types) #

[View source]
def generate_docs_json(program_type, types) #

[View source]
def generate_flags(string) #

Replaces flag keywords with html equivalent

Assumes that flag keywords are at the beginning of respective p element


[View source]
def generate_readme(program_type, types) #

[View source]
def generate_sitemap(types) #

[View source]
def generate_types_docs(types, dir, all_types) #

[View source]
def has_doc_annotations?(obj) #

[View source]
def isolate_flag_lines(string) #

Adds extra line break to flag keyword lines

Guarantees that line is within its own paragraph element when parsed


[View source]
def macro(type, a_macro) #

[View source]
def method(type, method, class_method) #

[View source]
def must_include?(const : Crystal::Const) #

[View source]
def must_include?(type : Crystal::Type) #

[View source]
def must_include?(a_def : Crystal::Def) #

[View source]
def must_include?(a_macro : Crystal::Macro) #

[View source]
def must_include?(constant : Constant) #

[View source]
def must_include?(a_nil : Nil) #

[View source]
def must_include?(type : Doc::Type) #

[View source]
def must_include?(method : Method) #

[View source]
def must_include?(a_macro : Doc::Macro) #

[View source]
def must_include?(location : Crystal::Location) #

[View source]
def must_include_toplevel?(program_type : Type) #

[View source]
def nodoc?(str : String | Nil) : Bool #

[View source]
def nodoc?(obj) #

[View source]
def program : Program #

[View source]
def program_type #

[View source]
def project_info : Crystal::Doc::ProjectInfo #

[View source]
def read_readme #

[View source]
def relative_location(node) #

[View source]
def relative_locations(type) #

[View source]
def run #

[View source]
def showdoc?(str : String | Nil) : Bool #

[View source]
def showdoc?(obj : Crystal::Type) #

[View source]
def summary(context, string) #

[View source]
def summary(obj : Type | Method | Macro | Constant) #

[View source]
def type(type) #

[View source]