Skip to content

Commit bfff884

Browse files
Remove parameter and return type stencil comments (#878)
1 parent a21d294 commit bfff884

File tree

599 files changed

+0
-3191
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

599 files changed

+0
-3191
lines changed

Sources/NodesGenerator/Resources/Stencils/Analytics.stencil

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,6 @@ internal final class {{ node_name }}AnalyticsImp {
3232
{% endfor %}
3333

3434
/// The initializer.
35-
{% if analytics_properties.count == 1 %}
36-
/// - Parameter {{ analytics_properties.first.name }}: The `{{ analytics_properties.first.type }}` instance
37-
{% else %}
38-
/// - Parameters:
39-
{% for property in analytics_properties %}
40-
/// - {{ property.name }}: The `{{ property.type }}` instance
41-
{% endfor %}
42-
{% endif %}
4335
init(
4436
{% for property in analytics_properties %}
4537
{{ property.name }}: {{ property.type }}{% if not forloop.last %}{{ ',' }}

Sources/NodesGenerator/Resources/Stencils/Builder-SwiftUI.stencil

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,6 @@ public final class {{ node_name }}Component: Component
8686
/// The initializer.
8787
///
8888
/// Remove `dynamicDependency` default parameter when its type is not `Void`.
89-
///
90-
/// - Parameters:
91-
/// - parent: The parent scope
92-
/// - dynamicDependency: The dynamic component dependency
9389
internal init(
9490
parent: Scope,
9591
dynamicDependency: {{ node_name }}DynamicComponentDependency = ()
@@ -146,8 +142,6 @@ internal final class {{ node_name }}BuilderImp: AbstractBuilder
146142
/// the dynamic component dependency.
147143
///
148144
/// The dynamic dependencies can be tuples containing multiple values when necessary.
149-
/// - Parameter listener: An object that can listen for signals from the Node
150-
/// - Returns: The Flow instance
151145
internal func build(
152146
withListener listener: {{ plugin_list_name }}Listener
153147
) -> {{ plugin_list_name }}Flow {
@@ -159,8 +153,6 @@ internal final class {{ node_name }}BuilderImp: AbstractBuilder
159153
/// the dynamic component dependency.
160154
///
161155
/// The dynamic dependencies can be tuples or structs containing multiple values when necessary.
162-
/// - Parameter listener: An object that can listen for signals from the Node
163-
/// - Returns: The Flow instance
164156
internal func build(
165157
withListener listener: {{ node_name }}Listener
166158
) -> {{ node_name }}Flow {
@@ -170,10 +162,6 @@ internal final class {{ node_name }}BuilderImp: AbstractBuilder
170162
}
171163

172164
/// The factory method in which the Context and Flow are initialized.
173-
/// - Parameters:
174-
/// - component: The component instance
175-
/// - dynamicBuildDependency: The dynamic build dependency
176-
/// - Returns: The Flow instance
177165
override internal func build(
178166
component: {{ node_name }}Component,
179167
dynamicBuildDependency: {{ node_name }}DynamicBuildDependency

Sources/NodesGenerator/Resources/Stencils/Builder.stencil

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -106,14 +106,6 @@ public final class {{ node_name }}Component: Component
106106
/// The initializer.
107107
///
108108
/// Remove `dynamicDependency` default parameter when its type is not `Void`.
109-
///
110-
{% if node_name == "App" %}
111-
/// - Parameter dynamicDependency: The dynamic component dependency
112-
{% else %}
113-
/// - Parameters:
114-
/// - parent: The parent scope
115-
/// - dynamicDependency: The dynamic component dependency
116-
{% endif %}
117109
internal init(
118110
{% if node_name != "App" %}
119111
parent: Scope,
@@ -201,8 +193,6 @@ internal final class {{ node_name }}BuilderImp: AbstractBuilder
201193
/// the dynamic component dependency.
202194
///
203195
/// The dynamic dependencies can be tuples containing multiple values when necessary.
204-
/// - Parameter listener: An object that can listen for signals from the Node
205-
/// - Returns: The Flow instance
206196
internal func build(
207197
withListener listener: {{ plugin_list_name }}Listener
208198
) -> {{ plugin_list_name }}Flow {
@@ -214,14 +204,6 @@ internal final class {{ node_name }}BuilderImp: AbstractBuilder
214204
/// the dynamic component dependency.
215205
///
216206
/// The dynamic dependencies can be tuples or structs containing multiple values when necessary.
217-
{% if owns_view %}
218-
/// - Parameter listener: An object that can listen for signals from the Node
219-
{% elif node_name != "App" %}
220-
/// - Parameters:
221-
/// - listener: An object that can listen for signals from the Node
222-
/// - viewController: The injected view controller
223-
{% endif %}
224-
/// - Returns: The Flow instance
225207
{% if node_name == "App" %}
226208
internal func build() -> {{ node_name }}Flow {
227209
{% else %}
@@ -242,10 +224,6 @@ internal final class {{ node_name }}BuilderImp: AbstractBuilder
242224
}
243225

244226
/// The factory method in which the Context and Flow are initialized.
245-
/// - Parameters:
246-
/// - component: The component instance
247-
/// - dynamicBuildDependency: The dynamic build dependency
248-
/// - Returns: The Flow instance
249227
override internal func build(
250228
component: {{ node_name }}Component,
251229
dynamicBuildDependency: {{ node_name }}DynamicBuildDependency

Sources/NodesGenerator/Resources/Stencils/Context.stencil

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,6 @@ internal final class {{ node_name }}ContextImp: AbstractContext {
8181
{% endif %}
8282

8383
/// The initializer.
84-
/// - Parameters:
85-
/// - workers: The Worker instances
86-
{% if owns_view %}
87-
/// - store: The Store instance
88-
{% endif %}
89-
/// - analytics: The Analytics instance
9084
{% if owns_view %}
9185
internal init<T: {{ store_prefix }}StateStore>(
9286
{% else %}

Sources/NodesGenerator/Resources/Stencils/Flow.stencil

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -59,21 +59,6 @@ internal final class {{ node_name }}FlowImp: AbstractFlow
5959
/// The initializer.
6060
///
6161
/// Inject Plugins or Builders into the Flow in order to create sub-Flows.
62-
/// - Parameters:
63-
/// - context: The Context instance
64-
{% if node_name != "App" %}
65-
/// - viewController: The View Controller instance
66-
{% endif %}
67-
{% for property in flow_properties %}
68-
/// - {{ property.name }}: The {{ property.type }} instance
69-
{% endfor %}
70-
{% if node_name == "App" %}
71-
/// - windowSceneBuilder: The Window Scene Builder instance
72-
{% elif node_name == "WindowScene" %}
73-
/// - windowBuilder: The Window Builder instance
74-
{% elif node_name == "Window" %}
75-
/// - rootBuilder: The Root Builder instance
76-
{% endif %}
7762
{% if node_name == "App" or node_name == "WindowScene" or node_name == "Window" or flow_properties %}
7863
internal init(
7964
{% else %}
@@ -122,8 +107,6 @@ internal final class {{ node_name }}FlowImp: AbstractFlow
122107
{% if owns_view or node_name == "WindowScene" %}
123108

124109
/// Provides the ``ViewControllable`` instance to the parent `Flow` for display or presentation.
125-
///
126-
/// - Returns: The ``ViewControllable`` instance.
127110
{% if node_name == "WindowScene" %}
128111
internal func getViewController() -> {{ node_name }}ViewControllable {
129112
{% else %}

Sources/NodesGenerator/Resources/Stencils/Plugin.stencil

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,6 @@ internal final class {{ plugin_name }}PluginImp: Plugin
8484
> {
8585

8686
/// The method in which the Plugin's enabled criteria is defined.
87-
/// - Parameters:
88-
/// - component: The component instance
89-
/// - state: The state
90-
/// - Returns: The enabled status of the Plugin
9187
override internal func isEnabled(
9288
component: {{ plugin_name }}PluginComponent,
9389
state: {{ plugin_name }}PluginStateType
@@ -96,8 +92,6 @@ internal final class {{ plugin_name }}PluginImp: Plugin
9692
}
9793

9894
/// The factory method in which the instance is initialized.
99-
/// - Parameter component: The component instance
100-
/// - Returns: The initialized instance
10195
override internal func build(
10296
component: {{ plugin_name }}PluginComponent
10397
) -> {{ plugin_name }}Builder {

Sources/NodesGenerator/Resources/Stencils/PluginList.stencil

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,6 @@ internal final class {{ plugin_list_name }}PluginListImp: PluginList
114114
> {
115115

116116
/// The method in which the Plugins are paired with keys and wrapped in type erased `AnyPlugin` instances.
117-
/// - Parameter component: The component instance
118-
/// - Returns: The Plugin collection
119117
override internal func plugins(
120118
component: {{ plugin_list_name }}PluginListComponent
121119
) -> KeyValuePairs<{{ plugin_list_name }}PluginListKeyType, AnyPlugin> {
@@ -129,10 +127,6 @@ internal final class {{ plugin_list_name }}PluginListImp: PluginList
129127
///
130128
/// There is no need to call `super` when overriding this method unless it is desirable to reference (or modify)
131129
/// the default order.
132-
/// - Parameters:
133-
/// - component: The component instance
134-
/// - state: The state
135-
/// - Returns: The keys defining the Plugin creation order
136130
override internal func creationOrder(
137131
component: {{ plugin_list_name }}PluginListComponent,
138132
state: {{ plugin_list_name }}PluginListStateType

Sources/NodesGenerator/Resources/Stencils/ViewController-SwiftUI.stencil

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,6 @@ internal struct {{ node_name }}View {
5151
{% endif %}
5252

5353
/// The initializer.
54-
///
55-
/// - Parameter store: The Store instance.
5654
internal init<T: {{ store_prefix }}ViewStateStore>(
5755
store: T
5856
) where T.ViewState == {{ node_name }}ViewState {

Sources/NodesGenerator/Resources/Stencils/ViewController.stencil

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,6 @@ internal final class {{ node_name }}ViewController: {{ view_controller_type }},
4444
{% endif %}
4545

4646
/// The initializer.
47-
///
48-
/// - Parameters:
49-
/// - initialState: The initial view state.
50-
/// - {{ view_state_property_name }}: {{ view_state_property_comment }}
5147
internal init(
5248
initialState: {{ node_name }}ViewState,
5349
{{ view_state_property_name }}: {{ publisher_type }}<{{ node_name }}ViewState{% if publisher_failure_type %}, {{ publisher_failure_type }}{% endif %}>

Sources/NodesGenerator/Resources/Stencils/ViewState.stencil

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,6 @@ internal struct {{ node_name }}ViewState: Equatable {}
2020
internal class {{ node_name }}ViewStateFactory: Nodes.Transform {
2121

2222
/// The factory method in which state is transformed into view state.
23-
///
24-
/// - Parameter state: The state.
25-
/// - Returns: The view state.
2623
internal func callAsFunction(
2724
_ state: {{ node_name }}State
2825
) -> {{ node_name }}ViewState {

0 commit comments

Comments
 (0)