Table (5) table: 0x55a4c3573c30
[
1
] =
Table (2)
table: 0x55a4c34982a0
[
"contents"
] =
Table (4)
table: 0x55a4c34982f0
[
"sanitize"
] =
Table (6)
table: 0x55a4c3498380
[
"type"
] =
" input:string -> escaped:string"
[
"summary"
] =
"Takes any string and escapes it to work with patterns."
[
"tags"
] =
Table (0)
table: 0x55a4c3498790
[
"is"
] =
"function"
[
"description"
] =
Table (0)
table: 0x55a4c34986f0
[
"name"
] =
Table (1)
table: 0x55a4c34984f0
[
1
] =
"sanitize"
[
"lines"
] =
Table (6)
table: 0x55a4c3499030
[
"type"
] =
" input:string -> lines:table"
[
"summary"
] =
"Splits a table into lines."
[
"tags"
] =
Table (0)
table: 0x55a4c34993f0
[
"is"
] =
"function"
[
"description"
] =
Table (1)
table: 0x55a4c3499350
[
1
] =
Table (2)
table: 0x55a4c3499440
[
"content"
] =
Table (1)
table: 0x55a4c3499490
[
1
] =
"Taken from [Penlight's `stringx` (`splitlines`)](https://stevedonovan.github.io/Penlight/api/libraries/pl.stringx.html#splitlines)."
[
"type"
] =
"text"
[
"name"
] =
Table (1)
table: 0x55a4c34990f0
[
1
] =
"lines"
[
"trim"
] =
Table (6)
table: 0x55a4c3498980
[
"type"
] =
" input:string -> trimmed:string, n:number"
[
"summary"
] =
"Trims the whitespace at each end of a string."
[
"tags"
] =
Table (0)
table: 0x55a4c3498cd0
[
"is"
] =
"function"
[
"description"
] =
Table (1)
table: 0x55a4c3498c30
[
1
] =
Table (2)
table: 0x55a4c3498d20
[
"content"
] =
Table (1)
table: 0x55a4c3498dd0
[
1
] =
"Taken from [Lua-users wiki's StringTrim (`trim11`)](http://lua-users.org/wiki/StringTrim)."
[
"type"
] =
"text"
[
"name"
] =
Table (1)
table: 0x55a4c3498a40
[
1
] =
"trim"
[
"lconcat"
] =
Table (6)
table: 0x55a4c3499720
[
"type"
] =
" la:[*], lb:[*] -> merged:[*]"
[
"summary"
] =
"Concatenates two lists"
[
"tags"
] =
Table (0)
table: 0x55a4c3499a30
[
"is"
] =
"function"
[
"description"
] =
Table (0)
table: 0x55a4c3499990
[
"name"
] =
Table (1)
table: 0x55a4c34997e0
[
1
] =
"lconcat"
[
"section"
] =
Table (4)
table: 0x55a4c3497df0
[
"id"
] =
1
[
"description"
] =
Table (1)
table: 0x55a4c3497f60
[
1
] =
Table (2)
table: 0x55a4c34980b0
[
"content"
] =
Table (1)
table: 0x55a4c3498160
[
1
] =
"Several utils used internally."
[
"type"
] =
"text"
[
"name"
] =
"Utils"
[
"tags"
] =
Table (1)
table: 0x55a4c3498000
[
"internal"
] =
true
[
2
] =
Table (2)
table: 0x55a4c3499ff0
[
"contents"
] =
Table (3)
table: 0x55a4c349a040
[
"extract"
] =
Table (6)
table: 0x55a4c349b0d0
[
"type"
] =
" input:string, language?:Language, options?:table -> comments:[GenericComment]"
[
"summary"
] =
"Extracts comment from a string separated by newlines."
[
"tags"
] =
Table (0)
table: 0x55a4c349b7a0
[
"is"
] =
"function"
[
"description"
] =
Table (5)
table: 0x55a4c349b700
[
1
] =
Table (3)
table: 0x55a4c349b830
[
"type"
] =
"header"
[
"content"
] =
Table (1)
table: 0x55a4c349b930
[
1
] =
"Available options"
[
"n"
] =
1
[
2
] =
Table (2)
table: 0x55a4c349b980
[
"content"
] =
Table (1)
table: 0x55a4c349b9d0
[
1
] =
"- `patterns:boolean` (`false`): Whether to use patterns for the language fields and ignore string or not."
[
"type"
] =
"text"
[
3
] =
Table (2)
table: 0x55a4c349ba50
[
"content"
] =
Table (1)
table: 0x55a4c349bb00
[
1
] =
'- `ignore:string` (`"///"`): String used to determine when to start or stop ignoring comments.'
[
"type"
] =
"text"
[
4
] =
Table (2)
table: 0x55a4c349bc20
[
"content"
] =
Table (1)
table: 0x55a4c349bcd0
[
1
] =
"- `merge:boolean` (`true`): Whether to merge adjacent single-line comments."
[
"type"
] =
"text"
[
5
] =
Table (2)
table: 0x55a4c349bd90
[
"content"
] =
Table (1)
table: 0x55a4c349be40
[
1
] =
'- `paragraphs:boolean` (`true`): Whether to split multi-line comments by empty strings (`""`).'
[
"type"
] =
"text"
[
"name"
] =
Table (1)
table: 0x55a4c349b3f0
[
1
] =
"extract"
[
"Language"
] =
Table (5)
table: 0x55a4c349a1a0
[
"name"
] =
Table (1)
table: 0x55a4c349a260
[
1
] =
"Language"
[
"tags"
] =
Table (0)
table: 0x55a4c349a590
[
"is"
] =
"type"
[
"description"
] =
Table (1)
table: 0x55a4c349a4f0
[
1
] =
Table (4)
table: 0x55a4c349a610
[
"content"
] =
Table (5)
table: 0x55a4c349a710
[
1
] =
"Language {"
[
2
] =
" single :: string"
[
3
] =
" multi :: [string]"
[
4
] =
" extensions :: [string]"
[
5
] =
"}"
[
"type"
] =
"snippet"
[
"language"
] =
"moon"
[
"title"
] =
"Format"
[
"summary"
] =
"Language type accepted by [`extract`](#extract)."
[
"GenericComment"
] =
Table (5)
table: 0x55a4c349a840
[
"name"
] =
Table (1)
table: 0x55a4c349ab20
[
1
] =
"GenericComment"
[
"tags"
] =
Table (0)
table: 0x55a4c349ae40
[
"is"
] =
"type"
[
"description"
] =
Table (1)
table: 0x55a4c349ada0
[
1
] =
Table (4)
table: 0x55a4c349ae90
[
"content"
] =
Table (5)
table: 0x55a4c349af90
[
1
] =
"GenericComment {"
[
2
] =
" start :: number"
[
3
] =
" end :: number"
[
4
] =
" content :: [string]"
[
5
] =
"}"
[
"type"
] =
"snippet"
[
"language"
] =
"moon"
[
"title"
] =
"Format"
[
"summary"
] =
"Comment returned by [`extract`](#extract)."
[
"section"
] =
Table (4)
table: 0x55a4c3499c00
[
"id"
] =
2
[
"description"
] =
Table (1)
table: 0x55a4c3499da0
[
1
] =
Table (2)
table: 0x55a4c3499e90
[
"content"
] =
Table (1)
table: 0x55a4c3499f40
[
1
] =
"This is the API provided to work with the generic backend."
[
"type"
] =
"text"
[
"name"
] =
"API"
[
"tags"
] =
Table (0)
table: 0x55a4c3499e40
[
"description"
] =
Table (7)
table: 0x55a4c3573f70
[
1
] =
Table (2)
table: 0x55a4c3574060
[
"content"
] =
Table (1)
table: 0x55a4c3574110
[
1
] =
"A generic implementation of a [backend](#/backend.md) for the Fir"
[
"type"
] =
"text"
[
2
] =
Table (2)
table: 0x55a4c35741d0
[
"content"
] =
Table (1)
table: 0x55a4c3574280
[
1
] =
"documentation generator."
[
"type"
] =
"text"
[
3
] =
Table (2)
table: 0x55a4c35744d0
[
"content"
] =
Table (1)
table: 0x55a4c3574520
[
1
] =
""
[
"type"
] =
"text"
[
4
] =
Table (2)
table: 0x55a4c35746b0
[
"content"
] =
Table (1)
table: 0x55a4c3574760
[
1
] =
"This specific implementation uses a `language` module (defaults to `fir.generic.languages`) to"
[
"type"
] =
"text"
[
5
] =
Table (2)
table: 0x55a4c3574830
[
"content"
] =
Table (1)
table: 0x55a4c35748e0
[
1
] =
"parse comments from any file."
[
"type"
] =
"text"
[
6
] =
Table (2)
table: 0x55a4c3574570
[
"content"
] =
Table (1)
table: 0x55a4c3497b30
[
1
] =
""
[
"type"
] =
"text"
[
7
] =
Table (2)
table: 0x55a4c3497c70
[
"content"
] =
Table (1)
table: 0x55a4c3497d20
[
1
] =
"Check out an example output of this backend [here](/examples/generic-backend.html)."
[
"type"
] =
"text"
[
"title"
] =
"fir.generic.backend"