-
Notifications
You must be signed in to change notification settings - Fork 8
Feature/deprecated annotation #16
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Conversation
* depricated tags are treates as arrays due to wiki support multiple per page. * Enum and Structs will collect deprecated tags for each item to later mark the specific entry as deprecated
Awesome that you're contributing, I really appreciate it. I'll check out your contributions later, but skimming over it I feel like I'll probably merge it without much feedback. |
@aske02 Everything looks good and I would merge it, were it not for my shitty tests failing. If you could adjust them so they pass that would be awesome. Thanks so much for this great contribution! |
I will take a look at the quick look at the test later |
This resulted in deprecated always being an empty string instead of being undefined
I've merged your contributions. Thanks for helping out! |
Looks like Stylua is complaining. I'll look at this when I'm back at a computer in a few weeks: https://github.com/luttje/glua-api-snippets/actions/runs/5703366710/job/15455948038 |
Need to run "npm run stylua-custom" |
Adds the ability for the scraper to collect tags from the wiki and add them add
---@deprecated
tags when generatingChanges to generating
The normal write functions have received a simple if statement that adds the deprecated tag with reason.
The only exception is the changes in
GluaApiWriter.writeStruct
which changes the syntax from using--@field
to instead applying a nil (or default) value directly to the class member in a local table.Old
New
Making these changes to
GluaApiWriter.writeStruct
andGluaApiWriter.writeClass
allows us to use default values where they are needed and use the---@deprecated
tag