Function argument parameters

[b0mbie]

Functions like net.Receive and concommand.Add have function parameters defined in function arguments' descriptions.

The arguments are defined in a bulleted list. Example for callback in concommand.Add in markup:

The function to run when the concommand is executed. Arguments passed are:
* <page>Player</page> ply - The player that ran the concommand. NULL entity if command was entered with the dedicated server console.
* <page>string</page> cmd - The concommand string (if one callback is used for several concommands).
* <page>table</page> args - A table of all string arguments.
* <page>string</page> argStr - The arguments as a string.

This, by hand, could be written as:

--- @param callback fun(ply: Player, cmd: string, args: table, argStr: string) # The function to run when the concommand is executed.

One possible problem with implementing this in the scraper is that the last sentence, Arguments passed are:, is meaningless if included in the argument description, thus it would have to be excluded. So, I think that functions with defined parameters can be hard-coded.

[luttje]

Good catch!

I think in this case it would be easiest to just hard-code these overrides in the custom/ directory. So in this case two files, one for each method (net.Receive.lua and concommand.Add.lua). It's been a while since I worked on that custom override feature though, so it's worth double-checking if I'm correct.

[b0mbie]

Yep, from looking at the scraper code, this seems to be right.
I'll see what I can do. It's been awesome using the definitions provided by the addon already, and I think having function arguments with defined parameters would be very useful.

[b0mbie]

I've implemented a big part of this in #40.