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

feat(deprecated): generate language specific deprecation markup #156

Merged

Conversation

eakoli
Copy link
Contributor

@eakoli eakoli commented Nov 2, 2023

If @deprecated is present in a comment, a deprecation marker will be generated.

@deprecated is expected to be at the start of a line, any text following it on the same line is added as the ‘message’ text where supported

This applies to records/attributes/constants, interfaces/methods/constants, enums/values, flags/values

Supports C++, Java and ObjC generators

…deprecated text in comments

If @deprecated is present in a comment, a deprecation marker will be generated.

@deprecated is expected to be at the start of a line, any text following it on the same line is added as the ‘message’ text where supported

This applies to records/attributes/constants, interfaces/methods/constants, enums/values, flags/values

Supports C++, Java and ObjC generators
@eakoli eakoli force-pushed the feat-deprecated-support branch from f8b6960 to 64cf608 Compare November 2, 2023 16:58
@a4z a4z requested review from a4z and jothepro November 2, 2023 18:41
@a4z
Copy link
Contributor

a4z commented Nov 2, 2023

Wow, this is nice! Thank you so much!!

Copy link
Contributor

@a4z a4z left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great PR!
We need to add this to the documentation.
But that can happen once it's merged.

@jothepro
Copy link
Contributor

jothepro commented Nov 3, 2023

Could be nice if this would also support setting the ObsoleteAttribute in C++/CLI! @eakoli would you be interested in adding it in this PR or should I open a separate issue for it?

Copy link
Contributor

@jothepro jothepro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

apart from that it's looking great, thank you so much!

@a4z
Copy link
Contributor

a4z commented Nov 6, 2023

If no other comments are made, I will soon merge this PR, and we will handle eventual ideas and additions, like docs, as extra issues.

@a4z a4z merged commit 98909ac into cross-language-cpp:main Nov 7, 2023
4 checks passed
@a4z
Copy link
Contributor

a4z commented Nov 7, 2023

Thanks a lot!
This requires a new release, which will follow soon

@a4z a4z mentioned this pull request Nov 7, 2023
a4z added a commit that referenced this pull request Nov 10, 2023
trblunt pushed a commit to trblunt/djinni that referenced this pull request Oct 3, 2024
Adds support for special handling of the @deprecated annotation in
IDL comments. When encountered, the generator will output language
specific deprecation markup.

This change is a port of the existing deprecation support in the
cross-language-cpp repository.

Ported "feat(deprecated): generate language specific deprecation markup"
Original author: @eakoli
Original PR: cross-language-cpp/djinni-generator#156
trblunt added a commit to trblunt/djinni that referenced this pull request Oct 3, 2024
Adds support for special handling of the @deprecated annotation in
IDL comments. When encountered, the generator will output language
specific deprecation markup.

This change is a port of the existing deprecation support in the
cross-language-cpp repository.

Ported "feat(deprecated): generate language specific deprecation markup"
Original author: @eakoli
Original PR: cross-language-cpp/djinni-generator#156
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 this pull request may close these issues.

3 participants