Add SwiftDoc for UITableView

Author: mac-cain13

Library/UIKit/UITableView+ReuseIdentifierProtocol.swift

@@ -10,27 +10,68 @@ import Foundation
 import UIKit
 
 public extension UITableView {
+  /**
+   Returns a typed reusable table-view cell object for the specified reuse identifier and adds it to the table.
+   
+   - parameter identifier: A R.reuseIdentifier.* value identifying the cell object to be reused.
+   - parameter indexPath: The index path specifying the location of the cell. The data source receives this information when it is asked for the cell and should just pass it along. This method uses the index path to perform additional configuration based on the cell’s position in the table view.
+   
+   - returns: The UITableViewCell subclass with the associated reuse identifier or nil if it couldn't be casted correctly.
+   
+   - precondition: You must register a class or nib file using the registerNib: or registerClass:forCellReuseIdentifier: method before calling this method.
+  */
   public func dequeueReusableCellWithIdentifier<Identifier: ReuseIdentifierProtocol where Identifier.ReusableType: UITableViewCell>(identifier: Identifier, forIndexPath indexPath: NSIndexPath) -> Identifier.ReusableType? {
     return dequeueReusableCellWithIdentifier(identifier.identifier, forIndexPath: indexPath) as? Identifier.ReusableType
   }
 
+  /**
+   Returns a typed reusable table-view cell object for the specified reuse identifier and adds it to the table.
+
+   - parameter identifier: A R.reuseIdentifier.* value identifying the cell object to be reused.
+
+   - returns: The UITableViewCell subclass with the associated reuse identifier or nil if it couldn't be casted correctly.
+
+   - precondition: You must register a class or nib file using the registerNib: or registerClass:forCellReuseIdentifier: method before calling this method.
+   */
   public func dequeueReusableCellWithIdentifier<Identifier: ReuseIdentifierProtocol where Identifier.ReusableType: UITableViewCell>(identifier: Identifier) -> Identifier.ReusableType? {
     return dequeueReusableCellWithIdentifier(identifier.identifier) as? Identifier.ReusableType
   }
 
+  /**
+   Returns a typed reusable header or footer view located by its identifier.
+   
+   - parameter identifier: A R.reuseIdentifier.* value identifying the header or footer view to be reused.
+   
+   - returns: A UITableViewHeaderFooterView object with the associated identifier or nil if no such object exists in the reusable view queue or if it couldn't be cast correctly.
+   */
   public func dequeueReusableHeaderFooterViewWithIdentifier<Identifier: ReuseIdentifierProtocol where Identifier.ReusableType: UITableViewCell>(identifier: Identifier) -> Identifier.ReusableType? {
     return dequeueReusableHeaderFooterViewWithIdentifier(identifier.identifier) as? Identifier.ReusableType
   }
 
+  /**
+   Register an array of R.nib.*, each containing a cell, with the table view under it's contained identifier.
+
+   - parameter nibResources: Array of nib resources (R.nib.*) each containing a table view cell that has a reuse identifier
+   */
+  public func registerNibs<Resource: NibResource where Resource: ReuseIdentifierProtocol, Resource.ReusableType: UITableViewCell>(nibResources: [Resource]) {
+    nibResources.forEach(registerNib)
+  }
+
+  /**
+   Register a R.nib.* containing a cell with the table view under it's contained identifier.
+   
+   - parameter nibResource: A nib resource (R.nib.*) containing a table view cell that has a reuse identifier
+  */
   public func registerNib<Resource: NibResource where Resource: ReuseIdentifierProtocol, Resource.ReusableType: UITableViewCell>(nibResource: Resource) {
     registerNib(nibResource.instance, forCellReuseIdentifier: nibResource.identifier)
   }
 
+  /**
+   Register a R.nib.* containing a header or footer with the table view under it's contained identifier.
+
+   - parameter nibResource: A nib resource (R.nib.*) containing a view that has a reuse identifier
+   */
   public func registerNibForHeaderFooterView<Resource: NibResource where Resource: ReuseIdentifierProtocol, Resource.ReusableType: UIView>(nibResource: Resource) {
     registerNib(nibResource.instance, forHeaderFooterViewReuseIdentifier: nibResource.identifier)
   }
-
-  public func registerNibs<Resource: NibResource where Resource: ReuseIdentifierProtocol, Resource.ReusableType: UITableViewCell>(nibResources: [Resource]) {
-    nibResources.forEach(registerNib)
-  }
 }