Support DocC Xcode 13 (#591)

* wip

* finish

* revert back code snippet identation to 5

* Update Sources/ComposableArchitecture/Effect.swift

Co-authored-by: Brandon Williams <[email protected]>

Co-authored-by: Brandon Williams <[email protected]>

Author: mluisbrown

Sources/ComposableArchitecture/Debugging/ReducerDebugging.swift

@@ -1,16 +1,20 @@
 import CasePaths
 import Dispatch
 
-/// Determines how the string description of an action should be printed when using the `.debug()`
+/// Determines how the string description of an action should be printed when using the ``Reducer/debug(prefix:state:action:environment:)``
 /// higher-order reducer.
 public enum ActionFormat {
   /// Prints the action in a single line by only specifying the labels of the associated values:
   ///
+  ///    ```swift
   ///     Action.screenA(.row(index:, action: .textChanged(query:)))
+  ///    ```
+  ///
   case labelsOnly
   /// Prints the action in a multiline, pretty-printed format, including all the labels of
   /// any associated values, as well as the data held in the associated values:
   ///
+  ///    ```swift
   ///     Action.screenA(
   ///       ScreenA.row(
   ///         index: 1,
@@ -19,6 +23,8 @@ public enum ActionFormat {
   ///         )
   ///       )
   ///     )
+  ///    ```
+  ///
   case prettyPrint
 }
 
@@ -31,7 +37,7 @@ extension Reducer {
   ///   - prefix: A string with which to prefix all debug messages.
   ///   - toDebugEnvironment: A function that transforms an environment into a debug environment by
   ///     describing a print function and a queue to print from. Defaults to a function that ignores
-  ///     the environment and returns a default `DebugEnvironment` that uses Swift's `print`
+  ///     the environment and returns a default ``DebugEnvironment`` that uses Swift's `print`
   ///     function and a background queue.
   /// - Returns: A reducer that prints debug messages for all received actions.
   public func debug(
@@ -58,7 +64,7 @@ extension Reducer {
   ///   - prefix: A string with which to prefix all debug messages.
   ///   - toDebugEnvironment: A function that transforms an environment into a debug environment by
   ///     describing a print function and a queue to print from. Defaults to a function that ignores
-  ///     the environment and returns a default `DebugEnvironment` that uses Swift's `print`
+  ///     the environment and returns a default ``DebugEnvironment`` that uses Swift's `print`
   ///     function and a background queue.
   /// - Returns: A reducer that prints debug messages for all received actions.
   public func debugActions(
@@ -87,7 +93,7 @@ extension Reducer {
   ///   - toLocalAction: A case path that filters actions that are printed.
   ///   - toDebugEnvironment: A function that transforms an environment into a debug environment by
   ///     describing a print function and a queue to print from. Defaults to a function that ignores
-  ///     the environment and returns a default `DebugEnvironment` that uses Swift's `print`
+  ///     the environment and returns a default ``DebugEnvironment`` that uses Swift's `print`
   ///     function and a background queue.
   /// - Returns: A reducer that prints debug messages for all received actions.
   public func debug<LocalState, LocalAction>(

Sources/ComposableArchitecture/Effects/Cancellation.swift

@@ -15,10 +15,11 @@ extension Effect {
   /// Turns an effect into one that is capable of being canceled.
   ///
   /// To turn an effect into a cancellable one you must provide an identifier, which is used in
-  /// `Effect.cancel(id:)` to identify which in-flight effect should be canceled. Any hashable
+  /// ``Effect/cancel(id:)`` to identify which in-flight effect should be canceled. Any hashable
   /// value can be used for the identifier, such as a string, but you can add a bit of protection
   /// against typos by defining a new type that conforms to `Hashable`, such as an empty struct:
   ///
+  ///    ```swift
   ///     struct LoadUserId: Hashable {}
   ///
   ///     case .reloadButtonTapped:
@@ -30,6 +31,7 @@ extension Effect {
   ///     case .cancelButtonTapped:
   ///       // Cancel any in-flight requests to load the user
   ///       return .cancel(id: LoadUserId())
+  ///    ```
   ///
   /// - Parameters:
   ///   - id: The effect's identifier.

Sources/ComposableArchitecture/Effects/Debouncing.swift

@@ -10,13 +10,15 @@ extension Effect {
   /// protection against typos by defining a new type that conforms to `Hashable`, such as an empty
   /// struct:
   ///
+  ///    ```swift
   ///     case let .textChanged(text):
   ///       struct SearchId: Hashable {}
   ///
   ///       return environment.search(text)
   ///         .map(Action.searchResponse)
   ///         .debounce(id: SearchId(), for: 0.5, scheduler: environment.mainQueue)
-  ///
+  ///    ```
+  ///    
   /// - Parameters:
   ///   - id: The effect's identifier.
   ///   - dueTime: The duration you want to debounce for.

Sources/ComposableArchitecture/Effects/Timer.swift

@@ -9,8 +9,9 @@ extension Effect where Value == Date, Error == Never {
   /// and which adds the the ability to be cancelled via the `id`.
   ///
   /// To start and stop a timer in your feature you can create the timer effect from an action
-  /// and then use the `.cancel(id:)` effect to stop the timer:
+  /// and then use the ``Effect/cancel(id:)`` effect to stop the timer:
   ///
+  ///    ```swift
   ///     struct AppState {
   ///       var count = 0
   ///     }
@@ -38,34 +39,37 @@ extension Effect where Value == Date, Error == Never {
   ///         state.count += 1
   ///         return .none
   ///     }
+  ///    ```
   ///
   /// Then to test the timer in this feature you can use a test scheduler to advance time:
   ///
-  ///   func testTimer() {
-  ///     let scheduler = TestScheduler()
+  ///    ```swift
+  ///     func testTimer() {
+  ///       let scheduler = TestScheduler()
   ///
-  ///     let store = TestStore(
-  ///       initialState: .init(),
-  ///       reducer: appReducer,
-  ///       envirnoment: .init(
-  ///         mainQueue: scheduler
+  ///       let store = TestStore(
+  ///         initialState: .init(),
+  ///         reducer: appReducer,
+  ///         envirnoment: .init(
+  ///           mainQueue: scheduler
+  ///         )
   ///       )
-  ///     )
   ///
-  ///     store.send(.startButtonTapped)
+  ///       store.send(.startButtonTapped)
   ///
-  ///     scheduler.advance(by: .seconds(1))
-  ///     store.receive(.timerTicked) { $0.count = 1 }
+  ///       scheduler.advance(by: .seconds(1))
+  ///       store.receive(.timerTicked) { $0.count = 1 }
   ///
-  ///     scheduler.advance(by: .seconds(5))
-  ///     store.receive(.timerTicked) { $0.count = 2 }
-  ///     store.receive(.timerTicked) { $0.count = 3 }
-  ///     store.receive(.timerTicked) { $0.count = 4 }
-  ///     store.receive(.timerTicked) { $0.count = 5 }
-  ///     store.receive(.timerTicked) { $0.count = 6 }
+  ///       scheduler.advance(by: .seconds(5))
+  ///       store.receive(.timerTicked) { $0.count = 2 }
+  ///       store.receive(.timerTicked) { $0.count = 3 }
+  ///       store.receive(.timerTicked) { $0.count = 4 }
+  ///       store.receive(.timerTicked) { $0.count = 5 }
+  ///       store.receive(.timerTicked) { $0.count = 6 }
   ///
-  ///     store.send(.stopButtonTapped)
-  ///   }
+  ///       store.send(.stopButtonTapped)
+  ///     }
+  ///    ```
   ///
   /// - Parameters:
   ///   - interval: The time interval on which to publish events. For example, a value of `0.5`