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

Highlight deprecated properties/methods in documentation and client-gen #10

Open
Genhis opened this issue May 23, 2020 · 1 comment
Open
Labels
enhancement New feature or request protocol
Milestone

Comments

@Genhis
Copy link

Genhis commented May 23, 2020

I have a kRPC property which I marked as Obsolete.

[KRPCProperty, Obsolete("MyReason")]
public float MyProperty { get; set; }

However, the generated documentation does not take in account Obsolete annotation and does not warn users about deprecation. I know I can add XML comments but it would be nice to have the property grayed out (the background?).

Furthermore, this change is not reflected in generated client source files either. For example, in Java, it could utilize @Deprecated annotation. I think this would help users remove deprecated calls as soon as possible without having to read the documentation or the changelog, because their compiler would warn them about deprecation.

@djungelorm djungelorm added the enhancement New feature or request label Mar 9, 2023
@djungelorm djungelorm added this to the 1.0.0 milestone Mar 9, 2023
@djungelorm
Copy link
Member

Great idea! Apologies for not getting to this sooner...

@djungelorm djungelorm mentioned this issue Mar 26, 2023
10 tasks
@djungelorm djungelorm transferred this issue from krpc/krpc Mar 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request protocol
Projects
None yet
Development

No branches or pull requests

2 participants