evaera / moonwave

Moonwave is a tool for generating documentation from comments in Lua source code.
https://eryn.io/moonwave/
Mozilla Public License 2.0
154 stars 23 forks source link

`@type` comments should auto-fill using the subsequent type definition #155

Open Nidoxs opened 4 weeks ago

Nidoxs commented 4 weeks ago

If you have declared a type in Luau and want to put that on your Moonwave documentation, you have to fill out the type value yourself. If it's a particularly long type, and one that changes often, it can be tedious to manage.

The @type comment, when no value is defined after the type name, should trigger the build process to look below and parse the type.

Example: image

It would be really cool for that type to be auto-filled for me.

Nidoxs commented 4 weeks ago

Glad to see this is already being considered! 😄

image

YetAnotherClown commented 4 weeks ago

Thanks for making an issue!