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

[Documentation] Add doc comments for NSObject #822

Merged
merged 1 commit into from
Jan 23, 2017

Conversation

broadwaylamb
Copy link
Contributor

@broadwaylamb broadwaylamb commented Jan 23, 2017

This pull request adds documentation comments for the following public/open declarations:

Classes:

Protocols:

  • NSObject

    • init()
    • copy()
    • mutableCopy()
    • isEqual(_:)
    • hash
    • self()
    • isProxy()
    • description
    • debugDescription
    • _cfTypeID
    • classForCoder
    • replacementObjectForCoder(_:)
    • classForKeyedArchiver
    • replacementObjectForKeyedArchiver(_:)
    • classFallbacksForKeyedArchiver()
    • classForKeyedUnarchiver()
    • hashValue
  • NSObjectProtocol

    • isEqual(_:)
    • hash
    • self()
    • isProxy()
    • description
    • debugDescription
  • NSCopying

    • copy(with:)
    • copy()
  • NSMutableCopying

    • mutableCopy(with:)
    • mutableCopy()

Functions:

  • ==(_:_:)

All the comments have been carefully reviewed. The terms referring to Objective-C semantics
have been substituted with ones more appropriate for Swift semantics (e. g. "receiver" → "instance" etc.).

Jazzy Percentage of documented declarations in Foundation
Before 23%
After 27%

@parkera
Copy link
Contributor

parkera commented Jan 23, 2017

Neat!

@parkera parkera merged commit ab1e214 into swiftlang:master Jan 23, 2017
@broadwaylamb broadwaylamb deleted the nsobject-doc branch January 23, 2017 17: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.

2 participants