[cxx-interop] Add documentation about inferring SWIFT_SHARED_REFERENCE in c++ inheritance #1078
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…E in c++ inheritance
fahadnayyar
requested review from
timsneath,
tkremenek,
shahmishal and
davelester
as code owners
Xazax-hun
reviewed
Jun 11, 2025
| @@ -1255,6 +1255,9 @@ object.doSomething() | |||
| // `object` will be released here. | |||
| ``` | |||
|
|
|||
| ### Inference for Derived Types | |||
| Swift compiler automatically infers the ```SWIFT_SHARED_REFERENCE``` annotation for C++ types that inherit from a base type annotated with ```SWIFT_SHARED_REFERENCE```. These derived types are imported as Swift reference types or Swift class types that use the same ```retain``` and ```release``` functions as the base type. No additional annotation is required on the derived types. | |||
There was a problem hiding this comment.
What do you mean by Swift reference types or Swift class types? I think we should just pick one terminology here.
Maybe we want to mention that this inference only happens if exactly one base type is annotated as a shared reference?
|
cc @egorzhdan |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding a sentence in the documentation thatthe foreign-reference annotations are now propagated to inherited C++ types