Document more of the public API

Author: indragiek

InAppViewDebugger/Element.swift

@@ -21,9 +21,19 @@ import CoreGraphics
         case important
     }
 
+    /// A human readable name for the element.
     @objc public let name: String?
+    
+    /// Classification for an element that determines how it is represented
+    /// in the view debugger.
     @objc public let classification: Classification
 
+    /// Constructs a new `Element`
+    ///
+    /// - Parameters:
+    ///   - name: A human readable name for the element
+    ///   - classification: Classification for an element that determines how it
+    /// is represented in the view debugger.
     @objc public init(name: String?, classification: Classification = .normal) {
         self.name = name
         self.classification = classification
@@ -32,11 +42,24 @@ import CoreGraphics
 
 /// A UI element that can be snapshotted.
 @objc(IAVDElement) public protocol Element {
+    /// Identifying information for the element, like its name and classification.
     var label: ElementLabel { get }
+    
+    /// A shortened description of the element.
     var shortDescription: String { get }
+    
+    /// The full length description of the element.
     var description: String { get }
+    
+    /// The frame of the element in its parent's coordinate space.
     var frame: CGRect { get }
+    
+    /// Whether the element is hidden from view or not.
     var isHidden: Bool { get }
+    
+    /// A snapshot image of the element in its current state.
     var snapshotImage: CGImage? { get }
+    
+    /// The child elements of the element.
     var children: [Element] { get }
 }

InAppViewDebugger/InAppViewDebugger.swift

@@ -8,6 +8,7 @@
 
 import UIKit
 
+/// Exposes APIs for presenting the view debugger.
 @objc public final class InAppViewDebugger: NSObject {
     /// Takes a snapshot of the application's key window and presents the debugger
     /// view controller from the root view controller.

InAppViewDebugger/Snapshot.swift

@@ -10,14 +10,32 @@ import Foundation
 
 /// A snapshot of the UI element tree in its current state.
 @objc(IAVDSnapshot) public final class Snapshot: NSObject {
+    /// Unique identifier for the snapshot.
     @objc public let identifier = UUID().uuidString
+    
+    /// Identifying information for the element, like its name and classification.
     @objc public let label: ElementLabel
+    
+    /// The frame of the element in its parent's coordinate space.
     @objc public let frame: CGRect
+    
+    /// Whether the element is hidden from view or not.
     @objc public let isHidden: Bool
+    
+    /// A snapshot image of the element in its current state.
     @objc public let snapshotImage: CGImage?
+    
+    /// The child snapshots of the snapshot (one per child element).
     @objc public let children: [Snapshot]
+    
+    /// The element used to create the snapshot.
     @objc public let element: Element
 
+    /// Constructs a new `Snapshot`
+    ///
+    /// - Parameter element: The element to construct the snapshot from. The
+    /// data stored in the snapshot will be the data provided by the element
+    /// at the time that this constructor is called.
     @objc public init(element: Element) {
         self.label = element.label
         self.frame = element.frame