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.

1 files changed, 5 insertions, 1 deletions

diff --git a/scripts/text_utils.lua b/scripts/text_utils.lua
index 5167ec42f2..ec0ccf668b 100644
--- a/scripts/text_utils.lua
+++ b/scripts/text_utils.lua
@@ -175,7 +175,11 @@ local function render_md(node, start_indent, indent, text_width, level, is_list)
       error(fmt('cannot render:\n%s', vim.inspect(node)))
     end
     for i, child in ipairs(node) do
-      vim.list_extend(parts, render_md(child, start_indent, indent, text_width, level + 1, is_list))
+      local start_indent0 = i == 1 and start_indent or indent
+      vim.list_extend(
+        parts,
+        render_md(child, start_indent0, indent, text_width, level + 1, is_list)
+      )
       if node.type ~= 'list' and i ~= #node then
         if (node[i + 1] or {}).type ~= 'list' then
           parts[#parts + 1] = '\n'