Skip to content

Add a comment to UnsafePointer assignment. #4070

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

Merged
merged 1 commit into from
Aug 20, 2016
Merged

Add a comment to UnsafePointer assignment. #4070

merged 1 commit into from
Aug 20, 2016

Conversation

atrick
Copy link
Contributor

@atrick atrick commented Aug 7, 2016

Initializing trivial types via assignment is allowed by convention,
so make it official.

/// type `Pointee`.
/// - Precondition: the pointee has been initialized with an
/// instance of type `Pointee` unless this is an assignment into
/// `pointee` and `Pointee` is a trivial type.
Copy link
Contributor

Choose a reason for hiding this comment

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

You ought to be able to doc-comment getters and setters separately, but I doubt our tooling can do anything useful with that. @natecook1000 should probably figure out the phrasing here; "this" doesn't seem like the right word to me.

Initializing trivial types via assignment is allowed by convention,
so make it official.
@atrick
Copy link
Contributor Author

atrick commented Aug 20, 2016

@swift-ci smoke test OS X.

@atrick atrick merged commit 3f2655e into swiftlang:master Aug 20, 2016
@atrick atrick deleted the assign-comment branch September 21, 2016 20:41
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