aboutsummaryrefslogtreecommitdiff
path: root/test/functional/script/luacats_parser_spec.lua
Commit message (Collapse)AuthorAge
* docs: improve/add documentation of Lua typesLewis Russell2024-03-01
- Added `@inlinedoc` so single use Lua types can be inlined into the functions docs. E.g. ```lua --- @class myopts --- @inlinedoc --- --- Documentation for some field --- @field somefield integer --- @param opts myOpts function foo(opts) end ``` Will be rendered as ``` foo(opts) Parameters: - {opts} (table) Object with the fields: - somefield (integer) Documentation for some field ``` - Marked many classes with with `@nodoc` or `(private)`. We can eventually introduce these when we want to.