add/finish adding moar docs

Author: designatednerd

Sources/Apollo/Bundle+Helpers.swift

@@ -23,10 +23,12 @@ extension Bundle {
     return self.bundleValue(forKey: String(kCFBundleIdentifierKey))
   }
 
+  /// The build number of this bundle (kCFBundleVersion) as a string, or nil if not present.
   var buildNumber: String? {
     return self.bundleValue(forKey: String(kCFBundleVersionKey))
   }
 
+  /// The short version string for this bundle, or nil if not present.
   var shortVersion: String? {
     return self.bundleValue(forKey: "CFBundleShortVersionString")
   }

Sources/ApolloWebSocket/WebSocketTask.swift

@@ -4,11 +4,19 @@ import Apollo
 import Foundation
 import Starscream
 
+/// A task to wrap sending/canceling operations over a websocket.
 final class WebSocketTask<Operation: GraphQLOperation>: Cancellable {
   let sequenceNumber : String?
   let transport: WebSocketTransport
 
-  init(_ ws: WebSocketTransport, _ operation: Operation, _ completionHandler: @escaping (_ result: Result<JSONObject, Error>) -> Void) {
+  /// Designated initializer
+  ///
+  /// - Parameter ws: The `WebSocketTransport` to use for this task
+  /// - Parameter operation: The `GraphQLOperation` to use
+  /// - Parameter completionHandler: A completion handler to fire when the operation has a result.
+  init(_ ws: WebSocketTransport,
+       _ operation: Operation,
+       _ completionHandler: @escaping (_ result: Result<JSONObject, Error>) -> Void) {
     sequenceNumber = ws.sendHelper(operation: operation, resultHandler: completionHandler)
     transport = ws
   }
@@ -19,7 +27,7 @@ final class WebSocketTask<Operation: GraphQLOperation>: Cancellable {
     }
   }
 
-  // unsubscribe same as cancel
+  // Unsubscribes from further results from this task.
   public func unsubscribe() {
     cancel()
   }

Sources/ApolloWebSocket/WebSocketTransport.swift

@@ -62,13 +62,13 @@ public class WebSocketTransport {
 
   /// Designated initializer
   ///
-  /// - Parameter request: <#request description#>
-  /// - Parameter clientName: <#clientName description#>
-  /// - Parameter clientVersion: <#clientVersion description#>
-  /// - Parameter sendOperationIdentifiers: <#sendOperationIdentifiers description#>
-  /// - Parameter reconnectionInterval: <#reconnectionInterval description#>
-  /// - Parameter connectingPayload: <#connectingPayload description#>
-  /// - Parameter requestCreator: <#requestCreator description#>
+  /// - Parameter request: The connection URLRequest
+  /// - Parameter clientName: The client name to use for this client. Defauls to `Self.defaultClientName`
+  /// - Parameter clientVersion: The client version to use for this client. Defaults to `Self.defaultClientVersion`.
+  /// - Parameter sendOperationIdentifiers: Whether or not to send operation identifiers with operations. Defaults to false.
+  /// - Parameter reconnectionInterval: How long to wait before attempting to reconnect. Defaults to half a second.
+  /// - Parameter connectingPayload: [optional] The payload to send on connection. Dfaults to an empty `GraphQLMap`.
+  /// - Parameter requestCreator: The request creator to use when serializing requests. Defaults to an `ApolloRequestCreator`.
   public init(request: URLRequest,
               clientName: String = WebSocketTransport.defaultClientName,
               clientVersion: String = WebSocketTransport.defaultClientVersion,