A different way to overload – am I even doing the right thing?

[aoqia194]

I'm currently in the process of implementing overloading in meta files via multiple declarations such as:

--- @meta

--- func desc
--- @param a string desc
--- @return string
function foo(a) end

--- func desc
--- @param a integer desc
--- @param b integer desc
--- @return integer
function foo(a, b) end

This method is also seen in luals. The reason for this is because there are times where a simple @overload is not so simple, or you want to document the overload in more detail (which is a separate feature I am working on a concept for as well). Short overloads in lua may be able to get away with, but when lua is an extension of another language with more complex function signatures like cpp/java, it can turn into absolute madness for external docs.

I am fairly new to the codebase and I am not sure if what I am doing is the correct way to be doing it. My two avenues I have gone down was:

1. Detecting duplicate globals in a meta file (as seen here) and making the second one an overload if possible -- I've already got this working for the most part
2. If the above is not reasonably possible, having an empty meta tag for the next function statement and process the overload at that stage (such would look like):

--- @overload
--- func overload desc
--- @param a string desc2
--- @param b string desc2
--- @return string
function foo(a, b)

I don't know if either of those approaches make sense for the project, so I am asking here for anyone who knows the project on what I should do here.

[CppCXY]

Currently, I haven't implemented global function overloading, but I have implemented this feature for xmake_ls. If you're interested, you can take a look for reference.

[aoqia194]

Thanks for the response, but I can't find where exactly the changes were made to support this. Everywhere I can see on the main branch, it is exactly the same overload handling as this repository. If you can, please let me know more!!!

[CppCXY]

I have implement this feature: daf8fa7

[aoqia194]

Thank you very much!!!