neovim/test/functional/script
Lewis Russell a5fe8f59d9 docs: improve/add documentation of Lua types
- 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.
2024-03-01 23:02:18 +00:00
..
luacats_grammar_spec.lua feat(docs): replace lua2dox.lua 2024-02-27 14:41:17 +00:00
luacats_parser_spec.lua docs: improve/add documentation of Lua types 2024-03-01 23:02:18 +00:00
text_utils_spec.lua docs: improve/add documentation of Lua types 2024-03-01 23:02:18 +00:00