add script to generate documents with docc

Author: p-x9

.gitignore

@@ -7,3 +7,5 @@ DerivedData/
 .swiftpm/config/registries.json
 .swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
 .netrc
+
+docs

Makefile

@@ -0,0 +1,7 @@
+.PHONY: docc
+docc:
+	bash scripts/docc.sh
+
+.PHONY: docc-preview
+docc-preview:
+	bash scripts/docc-preview.sh

Sources/TouchTracker/TouchTracker.docc/Resources/TouchTrackerExample.png

@@ -0,0 +1,48 @@
+# ``TouchTracker``
+
+👆Show a mark at the touched point on the View.
+
+@Metadata {
+    @DocumentationExtension(mergeBehavior: append)
+    @Available(iOS, introduced: "13.0")
+}
+
+<!--@START_MENU_TOKEN@-->Summary<!--@END_MENU_TOKEN@-->
+
+## Overview
+
+``TouchTracker`` allows you to display a mark on a touched point on your app with a simple setup.
+Both UIKit and SwiftUI are supported.
+
+![Example of TouchTracker](TouchTrackerExample.png)
+
+In SwiftUI, it can be used as follows
+
+```swift
+Text("Hello")
+    .touchTrack()
+```
+
+In the case of UIKit, this can be set by adding ``TouchTrackingUIView`` to the subview as follows.
+
+```swift
+let v = TouchTrackingUIView()
+
+self.view.addSubview(v)
+
+v.translatesAutoresizingMaskIntoConstraints = false
+NSLayoutConstraint.activate([
+    v.topAnchor.constraint(equalTo: window.topAnchor),
+    v.bottomAnchor.constraint(equalTo: window.bottomAnchor),
+    v.leftAnchor.constraint(equalTo: window.leftAnchor),
+    v.rightAnchor.constraint(equalTo: window.rightAnchor),
+])
+```
+
+<!--@START_MENU_TOKEN@-->Text<!--@END_MENU_TOKEN@-->
+
+## Topics
+
+### <!--@START_MENU_TOKEN@-->Group<!--@END_MENU_TOKEN@-->
+
+- <!--@START_MENU_TOKEN@-->``Symbol``<!--@END_MENU_TOKEN@-->

Sources/TouchTracker/TouchTracker.docc/TouchTracker.md

@@ -5,6 +5,7 @@ import UIKit
 #endif
 
 @available(macOS, unavailable)
+@available(iOS 13.0, *)
 public struct TouchTrackingView<Content: View>: View {
     let content: Content
 
@@ -85,6 +86,7 @@ public struct TouchTrackingView<Content: View>: View {
 }
 
 @available(macOS, unavailable)
+@available(iOS 13.0, *)
 extension TouchTrackingView {
     /// radius of mark on touched point
     public func touchPointRadius(_ radius: CGFloat) -> Self {

Sources/TouchTracker/TouchTracker.swift

@@ -0,0 +1,35 @@
+TARGET='TouchTracker'
+SCHEME='TouchTracker'
+
+clean_build() {
+  rm -rf ./.build
+}
+
+clean_xcbuild() {
+  destination=$1
+  xcodebuild -scheme "$SCHEME" \
+    -destination "generic/platform=${destination}" \
+    clean
+}
+
+generate_symbol_graphs() {
+  destination=$1
+
+  mkdir -p .build/symbol-graphs
+
+  xcodebuild -scheme ${SCHEME} \
+    -destination "generic/platform=${destination}" \
+    OTHER_SWIFT_FLAGS="-emit-extension-block-symbols -emit-symbol-graph -emit-symbol-graph-dir ./.build/symbol-graphs"
+
+  mv "./.build/symbol-graphs/$SCHEME.symbols.json" "./.build/symbol-graphs/${SCHEME}_${destination}.symbols.json"
+}
+
+clean_build
+clean_xcbuild ios
+
+generate_symbol_graphs ios
+
+$(xcrun --find docc) preview \
+  ./Sources/TouchTracker/TouchTracker.docc \
+  --additional-symbol-graph-dir .build/symbol-graphs \
+  --output-path "docs"

scripts/docc-preview.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+SCHEME='TouchTracker'
+REPO_NAME='TouchTracker'
+
+build_clean() {
+  destination="$1"
+
+  xcodebuild clean \
+    -destination "generic/platform=$destination" \
+    -scheme "$SCHEME"
+}
+
+generate_docc() {
+  destination="$1"
+
+  mkdir -p docs
+
+  xcodebuild docbuild \
+    -scheme "$SCHEME" \
+    -destination "generic/platform=$destination" \
+    OTHER_DOCC_FLAGS="--transform-for-static-hosting --hosting-base-path {REPO_NAME} --output-path docs" \
+    OTHER_SWIFT_FLAGS="-emit-extension-block-symbols"
+  # OTHER_SWIFT_FLAGS -symbol-graph-minimum-access-level private
+}
+
+build_clean ios
+generate_docc ios