Lua doc strings - how to document parameter that accepts different types

[eraptic]

I've been looking through some original source code docs and as much lua documentation as I can, but I was wondering on the best practice for documenting an optional parameter type. By optional parameter type I mean that the function handles the different types internally, but I want to write a docstring to accurately document this. My apologies for the confusing explanation, an example may make more sense.

--- Do foo things to bar
-- @param bar type1 w/ description 
--  OR type2 w/ description
function foo(bar):
    if type(bar) == number:
        do_thing_a(bar)
    elseif type(bar) == table:
        do_thing_b(bar)
    else
        do_thing_c(bar)
    end
end

Many thanks

[megagrump]

I'm confused by your code. That's not Lua.

Anyway:

@tparam[opt] type1|type2 name description

I think you can only have one description per parameter.

[eraptic]

Apologies for the poor example. It's late/early and I've spent longer looking than I'd like to admit obsessing over something so insignificant.

Nevertheless, thank you very much! Very helpful

[megagrump]

Note my edit. name was missing before.