Add support for default values for optional parameters to functions about ldoc HOT 3 CLOSED

I'm wondering what the doc comment should look like. Something like [opt='katana'] would be a logical extension. Or something like this:

   @param (default 'katana') .....

(inspired by how Lapp does it. But this may be a bit too free-form?)

from ldoc.

This is how I've done it (just pushed to master, ping me if you need a tag to download).

See e.g. tests/styles/four.lua

--- a function with typed args.
-- Note the the standard tparam aliases, and how the 'opt' and 'optchain'
-- modifiers may also be used. If the Lua function has varargs, then
-- you may document an indefinite number of extra arguments!
-- @string name person's name
-- @int age
-- @string[opt='gregorian'] calender optional calendar
-- @int[optchain=0] offset optional offset
-- @treturn string
function one (name,age,...)
end

Still find 'optchain' a bit hard to type. Perhaps if an 'opt' follows an 'opt' then it's implicitly 'optchain'?

from ldoc.

It just works like a charm. Gratitude for the swiftness!
I'll just close this issue.
And for the 'optchain' stuff, I am thinking the same way. It can be inferred when the previous arg is opt.

from ldoc.