[docs] Document @unsafe_no_objc_tagged_pointer #11887
Merged
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
Document @unsafe_no_objc_tagged_pointer
|
@swift-ci please smoke test and merge |
jrose-apple
reviewed
Sep 12, 2017
| @@ -121,6 +121,10 @@ Should only be used if necessary. This has the effect of forcing inlining to occ | |||
|
|
|||
| Use of this attribute imposes limitations on what can be in the body. For more details, refer to the [documentation](https://github.com/apple/swift/blob/master/docs/TransparentAttr.rst). | |||
|
|
|||
| #### `@unsafe_no_objc_tagged_pointer` | |||
|
|
|||
| This is currently used in the standard library as an additional annotation applied to @objc protocols signifying that any objects which conform to this protocol are not tagged. This means that (on Darwin platforms) such references, unlike AnyObject, have spare bits available from things like restricted memory spaces or alignment. | |||
There was a problem hiding this comment.
"Tagged" isn't really an adjective on its own in this context. I'd go with "are not represented by a tagged pointer", possibly with a link to some further documentation about tagged pointers.
There was a problem hiding this comment.
Derp, I had adjusted it and commited to my branch 30 seconds after swift-ci merged it!
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.
Document @unsafe_no_objc_tagged_pointer