Merge pull request #35 from p-x9/feature/add-doc-comments

add more doc comments

Author: p-x9

Sources/TouchTracker/Cocoa/TouchTrackingUIView.swift

@@ -9,6 +9,13 @@
 #if canImport(UIKit)
 import UIKit
 
+/// Anchor view to display a mark on a touched point in a UIKit View
+///
+/// You can use it by adding the touched point to a subview of the view you wish to display.
+///
+/// Since this view is simply used as an anchor, there is no problem setting isHidden to true or setting backgroundColor to clear.
+///
+///  By enabling `isShowLocation`, the coordinates displayed will be calculated using the upper left corner of this anchor view as the origin.
 public class TouchTrackingUIView: UIView {
     /// radius of mark on touched point
     public var radius: CGFloat
@@ -120,6 +127,8 @@ public class TouchTrackingUIView: UIView {
         UIWindow.hook()
     }
 
+    /// It is possible to use ``TouchPointStyle`` to set the initial settings for each property.
+    /// - Parameter style: Style settings such as mark size and color
     @available(iOS 14.0, *)
     public convenience init(style: TouchPointStyle) {
         self.init(

Sources/TouchTracker/Extension/UIWindow+.swift

@@ -24,7 +24,7 @@ extension UIView {
 }
 
 extension UIWindow {
-    static public var hooked = false
+    static var hooked = false
 
     static func hook() {
         if Self.hooked { return }

Sources/TouchTracker/Model/DisplayMode.swift

@@ -10,9 +10,13 @@
 import UIKit
 #endif
 
+/// Conditions for displaying touched points.
 public enum DisplayMode {
+    /// Always display touched points
     case always
+    /// Display touched points only during debug builds
     case debugOnly
+    /// Display touched points only during screen recording
     case recordingOnly
 }
 

Sources/TouchTracker/Model/TouchPointStyle.swift

@@ -8,6 +8,7 @@
 
 import SwiftUI
 
+/// Style of the mark displayed at the touched point
 public struct TouchPointStyle: Equatable {
     /// radius of mark on touched point
     public var radius: CGFloat

Sources/TouchTracker/TouchTracker.swift

@@ -4,6 +4,20 @@ import SwiftUI
 import UIKit
 #endif
 
+/// A view to display a mark on a touched point in a SwiftUI View
+///
+/// It can be used in the following two ways.
+/// - Wrap the content with this view
+///  ```swift
+///  TouchTrackingView {
+///    Text("Content View")
+///  }
+///  ```
+/// - Use modifier of SwiftUI.View
+///  ```swift
+///  Text("Content View")
+///      .touchTrack()
+///  ```
 @available(macOS, unavailable)
 @available(iOS 13.0, *)
 public struct TouchTrackingView<Content: View>: View {