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

Generated getter methods from RPC spec not aligned with the setter methods #380

Closed
crokita opened this issue Jan 21, 2021 · 0 comments · Fixed by #381
Closed

Generated getter methods from RPC spec not aligned with the setter methods #380

crokita opened this issue Jan 21, 2021 · 0 comments · Fixed by #381

Comments

@crokita
Copy link
Contributor

crokita commented Jan 21, 2021

Bug Report

The getter methods are different in how it documents whether it is deprecated. Firstly, it checks if the whole class has a deprecated flag, instead of checking whether the method specifically has that flag. This means that all getter methods would have the deprecated flag if the class itself has the tag. Secondly, it does not provide @since or version information regarding the deprecation.

Reproduction Steps

Run the generator

Expected Behavior

Getter documentation should match the setter documentation for deprecated methods.

Observed Behavior

The deprecated getter methods only have the tag @deprecated and no extra information such as @since or when the method was deprecated. Some getter methods mistakenly have the @deprecated tag on them. See DisplayCapabilities for an example.

Browser & Version Information

This is a generator bug, so all versions are affected.

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

Successfully merging a pull request may close this issue.

1 participant