Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Register* callback parameter type definition #502

Closed
Foereaper opened this issue Nov 29, 2024 · 1 comment
Closed

Documentation: Register* callback parameter type definition #502

Foereaper opened this issue Nov 29, 2024 · 1 comment

Comments

@Foereaper
Copy link
Member

Foereaper commented Nov 29, 2024

Currently we parse the parameter column documentation as a string with no implicit type definition. We thus cannot easily infer the parameter type for things like the LuaLS definition parser, or type linking like we have with arguments.

Since it is currently parsed as a string, we would have to perform a special operation on this field to extract any prefixed type information, which is not ideal. Maybe it would make more sense to implement a separate tag like < and > for the documentation parser, so it knows when to extract type information?

Leaving link to one of the documentation table values below.

* @values [1, ON_CHARACTER_CREATE, "WORLD", "event, player", ""]

Proposed format:

* @values [1, ON_CHARACTER_CREATE, "WORLD", <event: Number, player: Player>, ""]

@Foereaper
Copy link
Member Author

e3c8b12

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant