IGListKit/Source/NSObject+IGListDiffable.h
Jesse Squires 204f7d5390 Docs updates and refinements, #181
Summary:
Did a full pass on documentation.

- Clean up
- Fixes
- Better markdown

> **NOTE:** this PR does not re-gen docs. I will do that next. Before we cut 2.0
Closes https://github.com/Instagram/IGListKit/pull/198

Reviewed By: rnystrom

Differential Revision: D4181253

Pulled By: jessesquires

fbshipit-source-id: 133c4af392bb396ecc6eff0c895c55e6d18730b7
2016-11-15 11:44:10 -08:00

26 lines
965 B
Objective-C

/**
* Copyright (c) 2016-present, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*/
#import <Foundation/Foundation.h>
#import <IGListKit/IGListDiffable.h>
/**
This category adds diffing comparisons similar to adding the object into an `NSSet`,
where the object's `-isEqual:` method drives the uniqueness of the object.
For instance, an `NSString`'s `-isEqual:` will compare the value of the strings.
So if you were to diff `@"cat"` and `@"cat"` each object would have the same diff identifier.
However objects that don't implement a custom `-isEqual:` (e.g. the `NSObject` base class), the diff will default to simple
pointer comparisons to establish uniqueness.
*/
@interface NSObject (IGListDiffable) <IGListDiffable>
@end