Repository navigation
Add concise object-editing API documentation - #506
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Frotty
changed the title
|
@codex review |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 45764047e4
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
|
Codex Review: Didn't find any major issues. Bravo. Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
1 participant
Add documentation comments containing the four-character WC3 ability ID and
AbilityIdsconstant reference to all 1,581AbilityDefinitionwrappers, including the eight inherited compatibility aliases. This makes the class-to-rawcode mapping available in completion, hover, and generated API documentation.Constructors already use named IDs. Preserve all existing constructors, setters, presets, compatibility classes, and ID constants. Only comments change.
Add 988 short field comments for 90 metadata labels whose numeric/symbol notation is lost in method names (percentages and numbered attachment points, for example). Ordinary setters and presets receive no repetitive comments; shared level/preset behavior is documented once.
Add concise object-editing class examples and constructor guidance for units, items, buffs, doodads, and destructables, plus ID-generator collision guidance, upgrade effect-slot notes, and brief ID-package descriptions. Preserve existing API documentation and avoid inferred units or ranges.
Validation:
grill typecheck --quietsucceeded, the runnable examples also passed a compiler typecheck,grill test --quietpassed 524/524 tests, andgit diff --checkpassed. Every documented rawcode was resolved from the existingAbilityIdsmapping, including aliases resolved through their parent wrappers. Selective field labels come from the generated game metadata.Generator companion: wurstscript/WurstScript#1375
Addresses the class documentation request in wurstscript/wurst4vscode#139. The public API docs need rebuilding after this PR merges.