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

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

Open
Nidoxs opened this issue Aug 20, 2024 · 2 comments
Open

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

Nidoxs opened this issue Aug 20, 2024 · 2 comments
Labels
enhancement New feature or request extractor

Comments

@Nidoxs
Copy link

Nidoxs commented Aug 20, 2024

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
Copy link
Author

Nidoxs commented Aug 20, 2024

Glad to see this is already being considered! 😄

image

@YetAnotherClown
Copy link
Collaborator

Thanks for making an issue!

@YetAnotherClown YetAnotherClown added enhancement New feature or request extractor labels Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request extractor
Projects
None yet
Development

No branches or pull requests

2 participants