March Docs

Parser

Parser — extract doc entries from March source files.

Types

typeFnEntryFnEntry = FnEntry(String, String, Option(String), Bool, Int)#
typeTypeEntryTypeEntry = TypeEntry(String, String, Option(String), Int)#
typeIfaceEntryIfaceEntry = IfaceEntry(String, String, Option(String), List((String, String)), Int)#
typeModuleInfoModuleInfo = ModuleInfo(String, Option(String), List(FnEntry), List(TypeEntry), List(IfaceEntry), String)#

Functions

fncollect_triple_doccollect_triple_doc(lines)#
fndecl_namedecl_name(decl)#
fndrop_prefixdrop_prefix(s, prefix)#
fndrop_suffixdrop_suffix(s, suffix)#
fnentry_priventry_priv(e : FnEntry) : Bool#
fnextract_sigextract_sig(line)#
fnextract_single_docextract_single_doc(line)#
fnfn_linefn_line(e : FnEntry) : Int#
fniface_lineiface_line(e : IfaceEntry) : Int#
fnindent_widthindent_width(line)#
fninfo_nameinfo_name(m : ModuleInfo) : String#
fninfo_pathinfo_path(m : ModuleInfo) : String#
fnis_decl_kwis_decl_kw(t)#
fnis_prvis_prv(e : FnEntry) : Bool do entry_priv(e) end#
fnis_pubis_pub(e : FnEntry) : Bool do !entry_priv(e) end#
fnmodule_indentmodule_indent(lines)#
fnparse_entriesparse_entries(lines, include_private, mod_indent)#
fnparse_fileparse_file(path : String, include_private : Bool) : Option(ModuleInfo)#
fnparse_module_commentparse_module_comment(lines)#
fnparse_module_nameparse_module_name(lines)#
fnprocess_lineprocess_line(line, pending, fns, types, ifaces, include_private, line_num, mod_indent)#
fnstrip_kwstrip_kw(t)#
fntype_linetype_line(e : TypeEntry) : Int#