Skip to content

Commit f6b4eb8

Browse files
mluisbrownmluisbrown
committed
DocC Structure (#1180)
* DocC Structure * wip * wip * wip
1 parent d1f4d1b commit f6b4eb8

16 files changed

+752
-348
lines changed

‎Sources/ComposableArchitecture/Documentation.docc/Articles/SwiftUI.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# SwiftUI Integration
2+
3+
Integrating the Composable Architecture into a SwiftUI application.
4+
5+
## Overview
6+
7+
The Composable Architecture can be used to power applications built in many frameworks, but it was designed with SwiftUI in mind, and comes with many powerful tools to integrate into your SwiftUI applications.
8+
9+
## Topics
10+
11+
### View Containers
12+
13+
- ``WithViewStore``
14+
- ``IfLetStore``
15+
- ``ForEachStore``
16+
- ``SwitchStore``
17+
18+
### Bindings
19+
20+
- ``ViewStore/binding(get:send:)-65xes``
21+
- ``ViewStore/binding(get:send:)-l66r``
22+
- ``ViewStore/binding(send:)-7nwak``
23+
- ``ViewStore/binding(send:)-705m7``
24+
25+
### Bindable Domains
26+
27+
- ``BindableState``
28+
- ``BindableAction``
29+
- ``BindingAction``
30+
- ``Reducer/binding()``
31+
- ``ViewStore/binding(_:file:line:)``
32+
33+
### View State
34+
35+
- ``AlertState``
36+
- ``ConfirmationDialogState``
37+
- ``TextState``
38+
39+
<!--TODO: Can't currently document `View` extensions-->
40+
<!--### View Modifiers-->
41+
42+
### Deprecations
43+
44+
- <doc:SwiftUIDeprecations>

‎Sources/ComposableArchitecture/Documentation.docc/Articles/SwiftUIDeprecations.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Deprecations
2+
3+
Review unsupported SwiftUI APIs and their replacements.
4+
5+
## Overview
6+
7+
Avoid using deprecated APIs in your app. Select a method to see the replacement that you should use instead.
8+
9+
## Topics
10+
11+
### View State
12+
13+
- ``ActionSheetState``
14+
15+
<!--TODO: Can't currently document `View` extensions-->
16+
<!--### View Modifiers-->

‎Sources/ComposableArchitecture/Documentation.docc/Articles/UIKit.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# UIKit Integration
2+
3+
Integrating the Composable Architecture into a UIKit application.
4+
5+
## Overview
6+
7+
While the Composable Architecture was designed with SwiftUI in mind, it comes with tools to integrate into application code written in UIKit.
8+
9+
## Topics
10+
11+
### Store Scoping
12+
13+
- ``Store/ifLet(then:else:)``
14+
15+
### Subscribing to State Changes
16+
17+
- ``ViewStore/publisher``

‎Sources/ComposableArchitecture/Documentation.docc/ComposableArchitecture.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
### Essentials
2+
3+
- <doc:GettingStarted>
4+
5+
### State Management
6+
7+
- ``Reducer``
8+
- ``Effect``
9+
- ``Store``
10+
- ``ViewStore``
11+
12+
### Integrations
13+
14+
- <doc:SwiftUI>
15+
- <doc:UIKit>
16+
17+
### Testing
18+
19+
- ``TestStore``
20+
21+
## See Also
22+
23+
The collection of videos from [Point-Free](https://www.pointfree.co) that dive deep into the
24+
development of the library.
25+
26+
* [Point-Free Videos](https://www.pointfree.co/collections/composable-architecture)

‎Sources/ComposableArchitecture/Documentation.docc/Extensions/Effect.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# ``ComposableArchitecture/Effect``
2+
3+
## Topics
4+
5+
### Creating an Effect
6+
7+
- ``none``
8+
- ``init(value:)``
9+
- ``init(error:)``
10+
- ``run(_:)``
11+
- ``future(_:)``
12+
- ``catching(_:)``
13+
- ``result(_:)``
14+
- ``fireAndForget(_:)``
15+
- ``fireAndForget(priority:_:)``
16+
- ``task(priority:operation:)-7lrdd``
17+
18+
### Cancellation
19+
20+
- ``cancellable(id:cancelInFlight:)-499iv``
21+
- ``cancel(id:)-7vmd9``
22+
- ``cancel(ids:)-8gan2``
23+
- ``cancellable(id:cancelInFlight:)-17skv``
24+
- ``cancel(id:)-iun1``
25+
- ``cancel(ids:)-dmwy``
26+
27+
### Composition
28+
29+
<!--NB: DocC bug prevents the following from being resolved-->
30+
<!--- ``map(_:)``-->
31+
- ``merge(_:)-3al9f``
32+
- ``merge(_:)-4n451``
33+
- ``concatenate(_:)-3awnj``
34+
- ``concatenate(_:)-8x6rz``
35+
36+
### Timing
37+
38+
- ``deferred(for:scheduler:options:)``
39+
- ``debounce(id:for:scheduler:options:)-8x633``
40+
- ``debounce(id:for:scheduler:options:)-76yye``
41+
- ``throttle(id:for:scheduler:latest:)-9kwd5``
42+
- ``throttle(id:for:scheduler:latest:)-5jfpx``
43+
- ``timer(id:every:tolerance:on:options:)-4exe6``
44+
- ``timer(id:every:tolerance:on:options:)-7po0d``
45+
46+
### Testing
47+
48+
- ``unimplemented(_:)``
49+
50+
### SwiftUI Integration
51+
52+
- ``animation(_:)``
53+
54+
### Combine Integration
55+
56+
- ``receive(subscriber:)``
57+
- ``init(_:)``
58+
- ``upstream``
59+
- ``Subscriber``
60+
<!--TODO: Can't currently document `Publisher` extensions-->
61+
62+
### Deprecations
63+
64+
- <doc:EffectDeprecations>

‎Sources/ComposableArchitecture/Documentation.docc/Extensions/EffectDeprecations.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Deprecations
2+
3+
Review unsupported effect APIs and their replacements.
4+
5+
## Overview
6+
7+
Avoid using deprecated APIs in your app. Select a method to see the replacement that you should use instead.
8+
9+
## Topics
10+
11+
### Creating an Effect
12+
13+
- ``Effect/task(priority:operation:)-2czg0``
14+
15+
### Cancellation
16+
17+
- ``Effect/cancel(ids:)-9tnmm``
18+
19+
### Testing
20+
21+
- ``Effect/failing(_:)``

‎Sources/ComposableArchitecture/Documentation.docc/Extensions/Reducer.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# ``ComposableArchitecture/Reducer``
2+
3+
## Topics
4+
5+
### Creating a Reducer
6+
7+
- ``init(_:)``
8+
- ``empty``
9+
10+
### Invoking Reducers
11+
12+
- ``run(_:_:_:)``
13+
- ``callAsFunction(_:_:_:)``
14+
15+
### Composing Reducers
16+
17+
- ``combine(_:)-994ak``
18+
- ``combine(_:)-1ern2``
19+
- ``combined(with:)``
20+
- ``pullback(state:action:environment:)``
21+
- ``pullback(state:action:environment:file:line:)``
22+
- ``optional(file:line:)``
23+
- ``forEach(state:action:environment:file:line:)-gvte``
24+
- ``forEach(state:action:environment:file:line:)-21wow``
25+
- ``Identified``
26+
27+
### SwiftUI Integration
28+
29+
- ``binding()``
30+
31+
### Debugging Reducers
32+
33+
- ``debug(_:state:action:actionFormat:environment:)``
34+
- ``debug(_:actionFormat:environment:)``
35+
- ``debugActions(_:actionFormat:environment:)``
36+
- ``signpost(_:log:)``
37+
- ``ActionFormat``
38+
- ``DebugEnvironment``
39+
40+
### Deprecations
41+
42+
- <doc:ReducerDeprecations>

‎Sources/ComposableArchitecture/Documentation.docc/Extensions/ReducerDeprecations.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Deprecations
2+
3+
Review unsupported reducer APIs and their replacements.
4+
5+
## Overview
6+
7+
Avoid using deprecated APIs in your app. Select a method to see the replacement that you should use instead.
8+
9+
## Topics
10+
11+
### Composition
12+
13+
- ``Reducer/pullback(state:action:environment:breakpointOnNil:file:line:)``
14+
- ``Reducer/optional(breakpointOnNil:file:line:)``
15+
- ``Reducer/forEach(state:action:environment:breakpointOnNil:file:line:)-7h573``
16+
- ``Reducer/forEach(state:action:environment:breakpointOnNil:file:line:)-1h7qx``
17+
- ``Reducer/forEach(state:action:environment:breakpointOnNil:file:line:)-8iy04``
18+
19+
### SwiftUI Integration
20+
21+
- ``Reducer/binding(action:)``

‎Sources/ComposableArchitecture/Documentation.docc/Extensions/Store.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# ``ComposableArchitecture/Store``
2+
3+
## Topics
4+
5+
### Creating a Store
6+
7+
- ``init(initialState:reducer:environment:)``
8+
- ``unchecked(initialState:reducer:environment:)``
9+
10+
### Scoping Stores
11+
12+
- ``scope(state:action:)``
13+
- ``scope(state:)``
14+
- ``stateless``
15+
- ``actionless``
16+
17+
### Combine Integration
18+
19+
- ``StorePublisher``
20+
21+
### UIKit Integration
22+
23+
- ``ifLet(then:else:)``
24+
25+
### Deprecations
26+
27+
- <doc:StoreDeprecations>

‎Sources/ComposableArchitecture/Documentation.docc/Extensions/StoreDeprecations.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Deprecations
2+
3+
Review unsupported store APIs and their replacements.
4+
5+
## Overview
6+
7+
Avoid using deprecated APIs in your app. Select a method to see the replacement that you should use instead.
8+
9+
## Topics
10+
11+
### Scoping Stores
12+
13+
- ``Store/publisherScope(state:action:)``
14+
- ``Store/publisherScope(state:)``

0 commit comments

Comments
 (0)