Add Docc

Makefile

@@ -1,4 +1,6 @@
 MINTRUN = mint run
+DOCC_TARGET = SimplexArchitecture
+DOCC_DIR = ./docs
 
 .PHONY: bootstrap
 format:
@@ -15,3 +17,16 @@ test:
 .PHONY: benchmark
 benchmark:
 	swift run --configuration release swiftui-simplex-architecture-benchmark
+
+.PHONY: docc
+docc:
+	swift package --allow-writing-to-directory $(DOCC_DIR) \
+		generate-documentation --target $(DOCC_TARGET) \
+		--disable-indexing \
+		--transform-for-static-hosting \
+		--hosting-base-path swiftui-simplex-architecture \
+		--output-path $(DOCC_DIR) 
+
+.PHONY: docc-preview
+docc-preview:
+	swift package --disable-sandbox preview-documentation --target $(DOCC_TARGET)

Package.swift

@@ -27,6 +27,7 @@ let package = Package(
         .package(url: "https://github.com/pointfreeco/swiftui-navigation.git", exact: "1.0.2"),
         .package(url: "https://github.com/pointfreeco/swift-macro-testing.git", exact: "0.1.0"),
         .package(url: "https://github.com/google/swift-benchmark", from: "0.1.0"),
+        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.1.0"),
     ],
     targets: [
         // Targets are the basic building blocks of a package, defining a module or a test suite.

Sources/SimplexArchitecture/ActionSendable.swift

@@ -36,7 +36,7 @@ public extension ActionSendable {
     }
 
     @inline(__always)
-    func threadCheck() {
+    private func threadCheck() {
         #if DEBUG
             guard !Thread.isMainThread else {
                 return

Sources/SimplexArchitecture/Macros.swift

@@ -3,7 +3,7 @@
 /// It is conformed to the `ActionSendable` protocol by the `ViewState` macro.
 ///
 /// Here is a example code.
-/// ```
+/// ```Swift
 /// @ViewState
 /// struct MyView: View {
 ///     let store: Store<MyReducer> = Store(reducer: MyReducer())
@@ -30,7 +30,7 @@
 /// }
 /// ```
 /// Here is a sample code if you want to use ReducerState.
-/// ```
+/// ```Swift
 /// @ViewState
 /// struct MyView: View {
 ///     let store: Store<MyReducer>

Sources/SimplexArchitecture/Reducer/ReducerProtocol.swift

@@ -1,6 +1,6 @@
 /// A protocol that defines a reducer for a target type.
 ///
-/// ```
+/// ```Swift
 /// @Reducer
 /// struct MyReducer {
 ///     enum ViewAction {
@@ -41,7 +41,7 @@
 /// ```
 /// Also, `ReducerState` is useful to reduce unnecessary View updates. View is not updated when `ReducerState` changes. It can be used only with `Reducer`.
 ///
-/// ```
+/// ```Swift
 /// @Reducer
 /// struct MyReducer {
 ///     enum ViewAction {

Sources/SimplexArchitecture/StateContainer.swift

@@ -1,9 +1,12 @@
 import Foundation
 import XCTestDynamicOverlay
 
+/// Container that holds the reducer state and state for a given target conforming to `ActionSendable`.
+///
 /// StateContainer is not thread-safe. StateContainer must be accessed from MainActor.
 @dynamicMemberLookup
 public final class StateContainer<Target: ActionSendable> {
+    ///  Instance of ReducerState
     public var reducerState: Target.Reducer.ReducerState {
         _read { yield _reducerState! }
         _modify { yield &_reducerState! }