* docs

Pod/Classes/RxRealm.swift

@@ -17,14 +17,29 @@ extension AnyRealmCollection: NotificationEmitter {}
 extension Results: NotificationEmitter {}
 extension LinkingObjects: NotificationEmitter {}
 
+/**
+ `RealmChangeset` is a struct that contains the data about a single realm change set. 
+ 
+ It includes the insertions, modifications, and deletions indexes in the data set that the current notification is about.
+*/
 public struct RealmChangeset {
+    /// the indexes in the collection that were deleted
     public let deleted: [Int]
+    
+    /// the indexes in the collection that were inserted
     public let inserted: [Int]
+    
+    /// the indexes in the collection that were modified
     public let updated: [Int]
 }
 
 public extension NotificationEmitter where Self: RealmCollectionType {
     
+    /**
+     Returns an `Observable<Self>` that emits each time the collection data changes. The observable emits an initial value upon subscription.
+     
+     - returns: `Observable<Self>`, e.g. when called on `Results<Model>` it will return `Observable<Results<Model>>`, on a `List<User>` it will return `Observable<List<User>>`, etc.
+     */
     public func asObservable() -> Observable<Self> {
         return Observable.create {observer in
             let token = self.addNotificationBlock {changeset in
@@ -52,10 +67,26 @@ public extension NotificationEmitter where Self: RealmCollectionType {
         }
     }
     
+    /**
+     Returns an `Observable<Array<Self.Generator.Element>>` that emits each time the collection data changes. The observable emits an initial value upon subscription.
+     
+     This method emits an `Array` containing all the realm collection objects, this means they all live in the memory. If you're using this method to observe large collections you might hit memory warnings.
+     
+     - returns: `Observable<Array<Self.Generator.Element>>`, e.g. when called on `Results<Model>` it will return `Observable<Array<Model>>`, on a `List<User>` it will return `Observable<Array<User>>`, etc.
+     */
     public func asObservableArray() -> Observable<Array<Self.Generator.Element>> {
         return asObservable().map { Array($0) }
     }
 
+    /**
+     Returns an `Observable<(Self, RealmChangeset?)>` that emits each time the collection data changes. The observable emits an initial value upon subscription.
+     
+     When the observable emits for the first time (if the initial notification is not coalesced with an update) the second tuple value will be `nil`.
+     
+     Each following emit will include a `RealmChangeset` with the indexes inserted, deleted or modified.
+     
+     - returns: `Observable<(Self, RealmChangeset?)>`
+     */
     public func asObservableChangeset() -> Observable<(Self, RealmChangeset?)> {
         return Observable.create {observer in
             let token = self.addNotificationBlock {changeset in
@@ -77,6 +108,17 @@ public extension NotificationEmitter where Self: RealmCollectionType {
         }
     }
     
+    /**
+     Returns an `Observable<(Array<Self.Generator.Element>, RealmChangeset?)>` that emits each time the collection data changes. The observable emits an initial value upon subscription.
+     
+     This method emits an `Array` containing all the realm collection objects, this means they all live in the memory. If you're using this method to observe large collections you might hit memory warnings.
+     
+     When the observable emits for the first time (if the initial notification is not coalesced with an update) the second tuple value will be `nil`.
+     
+     Each following emit will include a `RealmChangeset` with the indexes inserted, deleted or modified.
+     
+     - returns: `Observable<(Array<Self.Generator.Element>, RealmChangeset?)>`
+     */
     public func asObservableArrayChangeset() -> Observable<(Array<Self.Generator.Element>, RealmChangeset?)> {
         return asObservableChangeset().map { (Array($0), $1) }
     }