Skip to content

Commit

Permalink
Updates documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
kzaher committed Jan 10, 2016
1 parent 59c0f90 commit b00d35a
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 41 deletions.
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,26 @@ All notable changes to this project will be documented in this file.

---

## [2.1.0](https://github.com/ReactiveX/RxSwift/releases/tag/2.1.0)

#### Features

* Adds `UIImagePickerController` delegate wrappers.
* Adds `SectionedViewDataSourceType` that enables third party data sources to use existing `rx_modelSelected`/`rx_modelDeselected` wrappers.
* Adds `rx_modelDeselected` to `UITableView`
* Adds `rx_itemDeselected` to `UITableView`
* Adds `rx_modelDeselected` to `UICollectionView`
* Adds `rx_itemDeselected` to `UICollectionView`
* Adds `rx_state` to `NSButton`
* Adds `rx_enabled` to `NSControl`
* Adds `UIImagePickerController` usage example to Example app.

#### Anomalies

* Removes usage of `OSSpinLock`s from all `Darwin` platforms because of problems with inversion of priority on iOS. [Original thread on swift mailing list is here](https://lists.swift.org/pipermail/swift-dev/Week-of-Mon-20151214/000321.html)
* Reduces verbose output from `RxCocoa` project in debug mode. `TRACE_RESOURCES` is now also treated as a verbosity level setting. It is possible to get old output by using `TRACE_RESOURCES` with verbosity level `>= 2`. [#397](https://github.com/ReactiveX/RxSwift/issues/397)
* Fixes anomaly with logging of HTTP body of requests in `RxCocoa` project.

## [2.0.0](https://github.com/ReactiveX/RxSwift/releases/tag/2.0.0)

#### Features
Expand Down
63 changes: 30 additions & 33 deletions Documentation/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ Operators are stateless by default.

* [`asObservable`](http://reactivex.io/documentation/operators/from.html)
* [`create`](http://reactivex.io/documentation/operators/create.html)
* [`defer`](http://reactivex.io/documentation/operators/defer.html)
* [`deferred`](http://reactivex.io/documentation/operators/defer.html)
* [`empty`](http://reactivex.io/documentation/operators/empty-never-throw.html)
* [`failWith`](http://reactivex.io/documentation/operators/empty-never-throw.html)
* [`from` (array)](http://reactivex.io/documentation/operators/from.html)
* [`error`](http://reactivex.io/documentation/operators/empty-never-throw.html)
* [`toObservable` (array)](http://reactivex.io/documentation/operators/from.html)
* [`interval`](http://reactivex.io/documentation/operators/interval.html)
* [`never`](http://reactivex.io/documentation/operators/empty-never-throw.html)
* [`returnElement` / `just`](http://reactivex.io/documentation/operators/just.html)
* [`returnElements`](http://reactivex.io/documentation/operators/from.html)
* [`just`](http://reactivex.io/documentation/operators/just.html)
* [`of`](http://reactivex.io/documentation/operators/from.html)
* [`range`](http://reactivex.io/documentation/operators/range.html)
* [`repeatElement`](http://reactivex.io/documentation/operators/repeat.html)
* [`timer`](http://reactivex.io/documentation/operators/timer.html)
Expand Down Expand Up @@ -118,15 +118,17 @@ extension NSObject {
extension NSObject {

public func rx_observe<Element>(
keyPath: String,
type: E.Type,
_ keyPath: String,
options: NSKeyValueObservingOptions = .New | .Initial,
retainSelf: Bool = true
) -> Observable<Element?> {}

#if !DISABLE_SWIZZLING

public func rx_observeWeakly<Element>(
keyPath: String,
type: E.Type,
_ keyPath: String,
options: NSKeyValueObservingOptions = .New | .Initial
) -> Observable<Element?> {}

Expand Down Expand Up @@ -320,14 +322,19 @@ extension UITableView {

public var rx_itemSelected: ControlEvent<NSIndexPath> {}

public var rx_itemDeselected: ControlEvent<NSIndexPath> {}

public var rx_itemInserted: ControlEvent<NSIndexPath> {}

public var rx_itemDeleted: ControlEvent<NSIndexPath> {}

public var rx_itemMoved: ControlEvent<ItemMovedEvent> {}

// This method only works in case one of the `rx_itemsWith*` methods was used.
public func rx_modelSelected<T>() -> ControlEvent<T> {}
// This method only works in case one of the `rx_itemsWith*` methods was used, or data source implements `SectionedViewDataSourceType`
public func rx_modelSelected<T>(modelType: T.Type) -> ControlEvent<T> {}

// This method only works in case one of the `rx_itemsWith*` methods was used, or data source implements `SectionedViewDataSourceType`
public func rx_modelDeselected<T>(modelType: T.Type) -> ControlEvent<T> {}

}
```
Expand All @@ -347,44 +354,30 @@ extension UICollectionView {

public var rx_itemSelected: ControlEvent<NSIndexPath> {}

// This method only works in case one of the `rx_itemsWith*` methods was used.
public func rx_modelSelected<T>() -> ControlEvent<T> {}
}
```

```swift
extension UIGestureRecognizer {
public var rx_itemDeselected: ControlEvent<NSIndexPath> {}

public var rx_event: ControlEvent<UIGestureRecognizer> {}
// This method only works in case one of the `rx_itemsWith*` methods was used, or data source implements `SectionedViewDataSourceType`
public func rx_modelSelected<T>(modelType: T.Type) -> ControlEvent<T> {}

// This method only works in case one of the `rx_itemsWith*` methods was used, or data source implements `SectionedViewDataSourceType`
public func rx_modelSelected<T>(modelType: T.Type) -> ControlEvent<T> {}
}
```

```swift
extension UIActionSheet {

public var rx_delegate: DelegateProxy {}

public var rx_clickedButtonAtIndex: ControlEvent<Int> {}

public var rx_willDismissWithButtonIndex: ControlEvent<Int> {}
extension UIGestureRecognizer {

public var rx_didDismissWithButtonIndex: ControlEvent<Int> {}
public var rx_event: ControlEvent<UIGestureRecognizer> {}

}
```


```swift
extension UIAlertView {
extension UIImagePickerController {

public var rx_delegate: DelegateProxy {}

public var rx_clickedButtonAtIndex: ControlEvent<Int> {}

public var rx_willDismissWithButtonIndex: ControlEvent<Int> {}
public var rx_didFinishPickingMediaWithInfo: Observable<[String : AnyObject]> {}

public var rx_didDismissWithButtonIndex: ControlEvent<Int> {}
public var rx_didCancel: Observable<()> {}

}
```
Expand Down Expand Up @@ -420,6 +413,8 @@ extension NSControl {

public var rx_controlEvent: ControlEvent<()> {}

public var rx_enabled: AnyObserver<Bool> {}

}
```

Expand All @@ -437,6 +432,8 @@ extension NSButton {

public var rx_tap: ControlEvent<Void> {}

public var rx_state: ControlProperty<Int> {}

}
```

Expand Down
16 changes: 8 additions & 8 deletions scripts/pre-release-tests.sh
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,14 @@ if [ "${RELEASE_TEST}" -eq 1 ]; then
CONFIGURATIONS=(Release Release-Tests Debug)
fi

#make sure all tvOS tests pass
if [ $TV_OS -eq 1 ]; then
for configuration in ${CONFIGURATIONS[@]}
do
rx "RxSwift-tvOS" ${configuration} $DEFAULT_TVOS_SIMULATOR test
done
fi

# make sure watchos builds
# temporary solution
WATCH_OS_BUILD_TARGETS=(RxSwift-watchOS RxCocoa-watchOS RxBlocking-watchOS)
Expand All @@ -62,14 +70,6 @@ do
rx "RxSwift-iOS" ${configuration} $DEFAULT_IOS9_SIMULATOR test
done

#make sure all tvOS tests pass
if [ $TV_OS -eq 1 ]; then
for configuration in ${CONFIGURATIONS[@]}
do
rx "RxSwift-tvOS" ${configuration} $DEFAULT_TVOS_SIMULATOR test
done
fi

#make sure all watchOS tests pass
#tests for Watch OS are not available rdar://21760513
# for configuration in ${CONFIGURATIONS[@]}
Expand Down

0 comments on commit b00d35a

Please sign in to comment.