How to annotate default arguments to parameters

[rhys-vdw]

Is there a standard way to annotate default arguments? I believe in LDoc you can do:

-- @string[opt='gregorian'] calendar optional calendar
-- @int[opt=0] offset optional offset

I'm currently converting some docs over and couldn't find anything in the wiki.

[CppCXY]

no this feature, to implement this feature, it is necessary to support parsing Lua expressions in the documentation, which might disrupt the existing documentation parsing method.

[lewis6991]

Some default arguments could be inferred from the body of the function. E.g. for lines like opts = opts or {}, or timeout = timeout or 300.

[rhys-vdw]

In my case I'm trying to generate them for C code, but I've just resolved to include the default in the comment for now.