[feature request] Ignore non-annotation (---) comments from description

[stativ]

Background: we have a a large project that contains lots of code in Lua that was written over they years. We are trying to document it now using sphinx-lua-ls, which uses Lua Language Server to extract description.

The idea was to use --- (three dashes) for writing the new docs as that's what we understood Lua Language Server uses to extract information about various fields. However, we are getting tons of unwanted documentation because we found that there are lots of comments for mostly internal stuff:

--- @class Foo
Foo = {}

--- Bar's the Foo
function Foo:bar()

end

-- some old comment that we do not want in the documentation, but which is useful for devs
function Foo:doInternalStuff()

end

It would be very useful to have an option that could force Lua Language Server to ignore any comments that are not --- from generating a description. That way it would be possible to use --- comments for writing a new user-facing documentation, while keeping the ordinary lua comments for commenting things that are not important to users.

[tomlau10]

This has been feature requested before: #2764
One suggestion is to add a Lua.doc.strictTripleDash = <boolean> config: #2764 (comment)
Maintainer agreed on this general direction but not yet implemented: #2764 (comment)

[stativ]

@tomlau10 thank you for pointing that issue out. I've closed this one as duplicate.