|
1 | | -# API diff for Objective-C and Swift code |
| 1 | +# API diff |
2 | 2 |
|
3 | 3 | [](https://travis-ci.org/material-motion/material-motion-apidiff) |
| 4 | +[](https://codecov.io/gh/material-motion/material-motion-apidiff) |
| 5 | + |
| 6 | +An API diff tool for Objective-C, Swift, and Android code that outputs markdown. |
| 7 | + |
| 8 | +## Requirements |
| 9 | + |
| 10 | +Engine for apple APIs requires: |
| 11 | + |
| 12 | +- Xcode 8 |
| 13 | +- [sourcekitten](https://github.com/jpsim/SourceKitten) |
| 14 | + |
| 15 | +## Usage |
| 16 | + |
| 17 | +Run `apidiff` from within a git repository like so: |
| 18 | + |
| 19 | + apidiff <old git ref> <new git ref> objc <umbrella header> |
| 20 | + apidiff <old git ref> <new git ref> swift <workspace path> <scheme name> |
| 21 | + apidiff <old git ref> <new git ref> android <library> |
| 22 | + |
| 23 | +# Example output |
| 24 | + |
| 25 | +Auto-generated by running: |
| 26 | + |
| 27 | + apidiff 734d43e406f53143c2cf8440f43d858d125f0a11 6f7a52744751e511d0daf119642446c46bed1f5c objc src/MaterialMotionRuntime.h |
| 28 | + |
| 29 | +## NewClass |
| 30 | + |
| 31 | +*new* class: `NewClass` |
| 32 | + |
| 33 | +*new* constructor: `NewClass()` |
| 34 | + |
| 35 | +*new* field: `text` |
| 36 | + |
| 37 | +*new* method: `getText()` |
| 38 | + |
| 39 | +## MDMPlanPerforming |
| 40 | + |
| 41 | +*removed* method: `-addPlan:` in `MDMPlanPerforming` |
| 42 | + |
| 43 | +*modified* protocol: `MDMPlanPerforming` |
| 44 | + |
| 45 | +| Type | swift declaration | |
| 46 | +|---|---| |
| 47 | +| From | `protocol MDMPlanPerforming : MDMPerforming` | |
| 48 | +| To | `protocol PlanPerforming : Performing` | |
| 49 | + |
| 50 | +## MDMScheduler |
| 51 | + |
| 52 | +*modified* property: `delegate` in `MDMScheduler` |
| 53 | + |
| 54 | +| Type | swift declaration | |
| 55 | +|---|---| |
| 56 | +| From | `weak var delegate: MDMSchedulerDelegate? { get set }` | |
| 57 | +| To | `weak var delegate: SchedulerDelegate? { get set }` | |
| 58 | + |
| 59 | +*modified* class: `MDMScheduler` |
| 60 | + |
| 61 | +| Type | swift declaration | |
| 62 | +|---|---| |
| 63 | +| From | `class MDMScheduler : NSObject` | |
| 64 | +| To | `class Scheduler : NSObject` | |
4 | 65 |
|
5 | 66 | ## License |
6 | 67 |
|
|
0 commit comments