Table (11) table: 0x55a88bc94d00
[
1
] =
Table (3)
table: 0x55a88bc686d0
[
"start"
] =
1
[
"content"
] =
Table (2)
table: 0x55a88bc77ff0
[
1
] =
"-# fir.generic.backend #---"
[
2
] =
" A generic implementation of a [backend](#/backend.md) for the Fir documentation generator."
[
"end"
] =
2
[
2
] =
Table (3)
table: 0x55a88bc78040
[
"start"
] =
4
[
"content"
] =
Table (2)
table: 0x55a88bc772b0
[
1
] =
" This specific implementation uses a `language` module (defaults to `fir.generic.languages`) to"
[
2
] =
" parse comments from any file."
[
"end"
] =
5
[
3
] =
Table (3)
table: 0x55a88bc77330
[
"start"
] =
7
[
"content"
] =
Table (1)
table: 0x55a88baeb510
[
1
] =
" This is yet another paragraph!"
[
"end"
] =
7
[
4
] =
Table (3)
table: 0x55a88bb47f60
[
"start"
] =
11
[
"content"
] =
Table (2)
table: 0x55a88ba9d490
[
1
] =
"# @internal Utils #--"
[
2
] =
" Several utils used internally."
[
"end"
] =
12
[
5
] =
Table (3)
table: 0x55a88bb66f20
[
"start"
] =
14
[
"content"
] =
Table (2)
table: 0x55a88bb448a0
[
1
] =
"- @function sanitize :: input:string -> escaped:string"
[
2
] =
"- Takes any string and escapes it to work with patterns."
[
"end"
] =
15
[
6
] =
Table (3)
table: 0x55a88bb2e170
[
"start"
] =
18
[
"content"
] =
Table (3)
table: 0x55a88bba8560
[
1
] =
"- @function trim :: input:string -> trimmed:string, n:number"
[
2
] =
"- Trims the whitespace at each end of a string."
[
3
] =
" Taken from [Lua-users wiki's StringTrim (`trim11`)](http://lua-users.org/wiki/StringTrim)."
[
"end"
] =
20
[
7
] =
Table (3)
table: 0x55a88bab1bf0
[
"start"
] =
23
[
"content"
] =
Table (3)
table: 0x55a88bab1cf0
[
1
] =
"- @function lines = input:string -> lines:table"
[
2
] =
"- Splits a table into lines."
[
3
] =
" Taken from [Penlight's `stringx` (`splitlines`)](https://stevedonovan.github.io/Penlight/api/libraries/pl.stringx.html#splitlines)."
[
"end"
] =
25
[
8
] =
Table (3)
table: 0x55a88bc08520
[
"start"
] =
40
[
"content"
] =
Table (2)
table: 0x55a88bc08660
[
1
] =
"- @function lconcat = la:[*], lb:[*] -> merged:[*]"
[
2
] =
"- Concatenates two lists"
[
"end"
] =
41
[
9
] =
Table (3)
table: 0x55a88bc70e40
[
"start"
] =
48
[
"content"
] =
Table (2)
table: 0x55a88bb599e0
[
1
] =
"# API #--"
[
2
] =
" This is the API provided to work with the generic backend."
[
"end"
] =
49
[
10
] =
Table (3)
table: 0x55a88bc03760
[
"start"
] =
51
[
"content"
] =
Table (9)
table: 0x55a88bc037f0
[
1
] =
"- @type Language"
[
2
] =
"- Language type accepted by [`extract`](#extract)."
[
3
] =
":moon Format"
[
4
] =
" {"
[
5
] =
" single :: string"
[
6
] =
" multi :: [string]"
[
7
] =
" extensions :: [string]"
[
8
] =
" }"
[
9
] =
":"
[
"end"
] =
59
[
11
] =
Table (3)
table: 0x55a88bb9a4f0
[
"start"
] =
61
[
"content"
] =
Table (7)
table: 0x55a88bb86a40
[
1
] =
"- @function extract :: input:string, language?:Language, options?:table"
[
2
] =
"- Extracts comment from a string separated by newlines."
[
3
] =
"# Available options"
[
4
] =
" - `patterns:boolean` (`false`): Whether to use patterns for the language fields and ignore string or not."
[
5
] =
' - `ignore:string` (`"///"`): String used to determine when to start or stop ignoring comments.'
[
6
] =
" - `merge:boolean` (`true`): Whether to merge adjacent single-line comments."
[
7
] =
' - `paragraphs:boolean` (`true`): Whether to split multi-line comments by empty strings (`""`).'
[
"end"
] =
67