Skip to content

Commit 521e6cf

Browse files
Adjust interface template comments (#905)
1 parent b724e74 commit 521e6cf

File tree

33 files changed

+99
-231
lines changed

33 files changed

+99
-231
lines changed

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

+3-7
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,17 @@ import {{ import }}
66
{% endfor %}
77
{% endif %}
88

9-
// This file defines the protocols and types in the interface requiring public ACL for use in another module.
9+
/*
10+
This file defines the protocols and types in the interface requiring public ACL for use in another module.
11+
*/
1012
{% if node_name != "App" %}
1113

12-
// MARK: - Listener
13-
1414
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
1515
/// @mockable
1616
@MainActor
1717
internal protocol {{ node_name }}Listener: AnyObject {}
1818
{% endif %}
1919

20-
// MARK: - Flow
21-
2220
/// @mockable
2321
@MainActor
2422
{% if plugin_list_name %}
@@ -27,8 +25,6 @@ internal protocol {{ node_name }}Flow: {{ plugin_list_name }}Flow {}
2725
internal protocol {{ node_name }}Flow: {{ view_controllable_flow_type }} {}
2826
{% endif %}
2927

30-
// MARK: - Builder
31-
3228
{% if is_periphery_comment_enabled %}
3329
// periphery:ignore
3430
{% endif %}

Tests/NodesGeneratorTests/__Snapshots__/StencilRendererTests/testRenderNode.Interface-AppKitSwiftUI-mockCount-0.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
11
//<fileHeader>
22

3-
// This file defines the protocols and types in the interface requiring public ACL for use in another module.
4-
5-
// MARK: - Listener
3+
/*
4+
This file defines the protocols and types in the interface requiring public ACL for use in another module.
5+
*/
66

77
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
88
/// @mockable
99
@MainActor
1010
internal protocol <nodeName>Listener: AnyObject {}
1111

12-
// MARK: - Flow
13-
1412
/// @mockable
1513
@MainActor
1614
internal protocol <nodeName>Flow: <viewControllableFlowType> {}
1715

18-
// MARK: - Builder
19-
2016
/// @mockable
2117
@MainActor
2218
internal protocol <nodeName>Builder: AnyObject {

Tests/NodesGeneratorTests/__Snapshots__/StencilRendererTests/testRenderNode.Interface-AppKitSwiftUI-mockCount-1.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,19 @@
22

33
import <interfaceImport>
44

5-
// This file defines the protocols and types in the interface requiring public ACL for use in another module.
6-
7-
// MARK: - Listener
5+
/*
6+
This file defines the protocols and types in the interface requiring public ACL for use in another module.
7+
*/
88

99
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
1010
/// @mockable
1111
@MainActor
1212
internal protocol <nodeName>Listener: AnyObject {}
1313

14-
// MARK: - Flow
15-
1614
/// @mockable
1715
@MainActor
1816
internal protocol <nodeName>Flow: <pluginListName>Flow {}
1917

20-
// MARK: - Builder
21-
2218
// periphery:ignore
2319
/// @mockable
2420
@MainActor

Tests/NodesGeneratorTests/__Snapshots__/StencilRendererTests/testRenderNode.Interface-AppKitSwiftUI-mockCount-2.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,19 @@
33
import <interfaceImport1>
44
import <interfaceImport2>
55

6-
// This file defines the protocols and types in the interface requiring public ACL for use in another module.
7-
8-
// MARK: - Listener
6+
/*
7+
This file defines the protocols and types in the interface requiring public ACL for use in another module.
8+
*/
99

1010
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
1111
/// @mockable
1212
@MainActor
1313
internal protocol <nodeName>Listener: AnyObject {}
1414

15-
// MARK: - Flow
16-
1715
/// @mockable
1816
@MainActor
1917
internal protocol <nodeName>Flow: <pluginListName>Flow {}
2018

21-
// MARK: - Builder
22-
2319
// periphery:ignore
2420
/// @mockable
2521
@MainActor

Tests/NodesGeneratorTests/__Snapshots__/StencilRendererTests/testRenderNode.Interface-UIKitSwiftUI-mockCount-0.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
11
//<fileHeader>
22

3-
// This file defines the protocols and types in the interface requiring public ACL for use in another module.
4-
5-
// MARK: - Listener
3+
/*
4+
This file defines the protocols and types in the interface requiring public ACL for use in another module.
5+
*/
66

77
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
88
/// @mockable
99
@MainActor
1010
internal protocol <nodeName>Listener: AnyObject {}
1111

12-
// MARK: - Flow
13-
1412
/// @mockable
1513
@MainActor
1614
internal protocol <nodeName>Flow: <viewControllableFlowType> {}
1715

18-
// MARK: - Builder
19-
2016
/// @mockable
2117
@MainActor
2218
internal protocol <nodeName>Builder: AnyObject {

Tests/NodesGeneratorTests/__Snapshots__/StencilRendererTests/testRenderNode.Interface-UIKitSwiftUI-mockCount-1.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,19 @@
22

33
import <interfaceImport>
44

5-
// This file defines the protocols and types in the interface requiring public ACL for use in another module.
6-
7-
// MARK: - Listener
5+
/*
6+
This file defines the protocols and types in the interface requiring public ACL for use in another module.
7+
*/
88

99
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
1010
/// @mockable
1111
@MainActor
1212
internal protocol <nodeName>Listener: AnyObject {}
1313

14-
// MARK: - Flow
15-
1614
/// @mockable
1715
@MainActor
1816
internal protocol <nodeName>Flow: <pluginListName>Flow {}
1917

20-
// MARK: - Builder
21-
2218
// periphery:ignore
2319
/// @mockable
2420
@MainActor

Tests/NodesGeneratorTests/__Snapshots__/StencilRendererTests/testRenderNode.Interface-UIKitSwiftUI-mockCount-2.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,19 @@
33
import <interfaceImport1>
44
import <interfaceImport2>
55

6-
// This file defines the protocols and types in the interface requiring public ACL for use in another module.
7-
8-
// MARK: - Listener
6+
/*
7+
This file defines the protocols and types in the interface requiring public ACL for use in another module.
8+
*/
99

1010
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
1111
/// @mockable
1212
@MainActor
1313
internal protocol <nodeName>Listener: AnyObject {}
1414

15-
// MARK: - Flow
16-
1715
/// @mockable
1816
@MainActor
1917
internal protocol <nodeName>Flow: <pluginListName>Flow {}
2018

21-
// MARK: - Builder
22-
2319
// periphery:ignore
2420
/// @mockable
2521
@MainActor

Tests/NodesGeneratorTests/__Snapshots__/StencilRendererTests/testRenderNode_withPlugin.Interface-AppKitSwiftUI-mockCount-0.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
11
//<fileHeader>
22

3-
// This file defines the protocols and types in the interface requiring public ACL for use in another module.
4-
5-
// MARK: - Listener
3+
/*
4+
This file defines the protocols and types in the interface requiring public ACL for use in another module.
5+
*/
66

77
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
88
/// @mockable
99
@MainActor
1010
internal protocol <nodeName>Listener: AnyObject {}
1111

12-
// MARK: - Flow
13-
1412
/// @mockable
1513
@MainActor
1614
internal protocol <nodeName>Flow: <viewControllableFlowType> {}
1715

18-
// MARK: - Builder
19-
2016
/// @mockable
2117
@MainActor
2218
internal protocol <nodeName>Builder: AnyObject {

Tests/NodesGeneratorTests/__Snapshots__/StencilRendererTests/testRenderNode_withPlugin.Interface-AppKitSwiftUI-mockCount-1.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,19 @@
22

33
import <interfaceImport>
44

5-
// This file defines the protocols and types in the interface requiring public ACL for use in another module.
6-
7-
// MARK: - Listener
5+
/*
6+
This file defines the protocols and types in the interface requiring public ACL for use in another module.
7+
*/
88

99
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
1010
/// @mockable
1111
@MainActor
1212
internal protocol <nodeName>Listener: AnyObject {}
1313

14-
// MARK: - Flow
15-
1614
/// @mockable
1715
@MainActor
1816
internal protocol <nodeName>Flow: <pluginListName>Flow {}
1917

20-
// MARK: - Builder
21-
2218
// periphery:ignore
2319
/// @mockable
2420
@MainActor

Tests/NodesGeneratorTests/__Snapshots__/StencilRendererTests/testRenderNode_withPlugin.Interface-AppKitSwiftUI-mockCount-2.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,19 @@
33
import <interfaceImport1>
44
import <interfaceImport2>
55

6-
// This file defines the protocols and types in the interface requiring public ACL for use in another module.
7-
8-
// MARK: - Listener
6+
/*
7+
This file defines the protocols and types in the interface requiring public ACL for use in another module.
8+
*/
99

1010
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
1111
/// @mockable
1212
@MainActor
1313
internal protocol <nodeName>Listener: AnyObject {}
1414

15-
// MARK: - Flow
16-
1715
/// @mockable
1816
@MainActor
1917
internal protocol <nodeName>Flow: <pluginListName>Flow {}
2018

21-
// MARK: - Builder
22-
2319
// periphery:ignore
2420
/// @mockable
2521
@MainActor

Tests/NodesGeneratorTests/__Snapshots__/StencilRendererTests/testRenderNode_withPlugin.Interface-UIKitSwiftUI-mockCount-0.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
11
//<fileHeader>
22

3-
// This file defines the protocols and types in the interface requiring public ACL for use in another module.
4-
5-
// MARK: - Listener
3+
/*
4+
This file defines the protocols and types in the interface requiring public ACL for use in another module.
5+
*/
66

77
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
88
/// @mockable
99
@MainActor
1010
internal protocol <nodeName>Listener: AnyObject {}
1111

12-
// MARK: - Flow
13-
1412
/// @mockable
1513
@MainActor
1614
internal protocol <nodeName>Flow: <viewControllableFlowType> {}
1715

18-
// MARK: - Builder
19-
2016
/// @mockable
2117
@MainActor
2218
internal protocol <nodeName>Builder: AnyObject {

Tests/NodesGeneratorTests/__Snapshots__/StencilRendererTests/testRenderNode_withPlugin.Interface-UIKitSwiftUI-mockCount-1.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,19 @@
22

33
import <interfaceImport>
44

5-
// This file defines the protocols and types in the interface requiring public ACL for use in another module.
6-
7-
// MARK: - Listener
5+
/*
6+
This file defines the protocols and types in the interface requiring public ACL for use in another module.
7+
*/
88

99
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
1010
/// @mockable
1111
@MainActor
1212
internal protocol <nodeName>Listener: AnyObject {}
1313

14-
// MARK: - Flow
15-
1614
/// @mockable
1715
@MainActor
1816
internal protocol <nodeName>Flow: <pluginListName>Flow {}
1917

20-
// MARK: - Builder
21-
2218
// periphery:ignore
2319
/// @mockable
2420
@MainActor

Tests/NodesGeneratorTests/__Snapshots__/StencilRendererTests/testRenderNode_withPlugin.Interface-UIKitSwiftUI-mockCount-2.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,19 @@
33
import <interfaceImport1>
44
import <interfaceImport2>
55

6-
// This file defines the protocols and types in the interface requiring public ACL for use in another module.
7-
8-
// MARK: - Listener
6+
/*
7+
This file defines the protocols and types in the interface requiring public ACL for use in another module.
8+
*/
99

1010
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
1111
/// @mockable
1212
@MainActor
1313
internal protocol <nodeName>Listener: AnyObject {}
1414

15-
// MARK: - Flow
16-
1715
/// @mockable
1816
@MainActor
1917
internal protocol <nodeName>Flow: <pluginListName>Flow {}
2018

21-
// MARK: - Builder
22-
2319
// periphery:ignore
2420
/// @mockable
2521
@MainActor

Tests/NodesGeneratorTests/__Snapshots__/StencilRendererTests/testRenderNode_withPluginAndTests.Interface-AppKitSwiftUI-mockCount-0.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
11
//<fileHeader>
22

3-
// This file defines the protocols and types in the interface requiring public ACL for use in another module.
4-
5-
// MARK: - Listener
3+
/*
4+
This file defines the protocols and types in the interface requiring public ACL for use in another module.
5+
*/
66

77
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
88
/// @mockable
99
@MainActor
1010
internal protocol <nodeName>Listener: AnyObject {}
1111

12-
// MARK: - Flow
13-
1412
/// @mockable
1513
@MainActor
1614
internal protocol <nodeName>Flow: <viewControllableFlowType> {}
1715

18-
// MARK: - Builder
19-
2016
/// @mockable
2117
@MainActor
2218
internal protocol <nodeName>Builder: AnyObject {

0 commit comments

Comments
 (0)