Skip to content

Commit 1c6d000

Browse files
Adjust interface template comments (#904)
1 parent 4e1fa11 commit 1c6d000

File tree

140 files changed

+420
-552
lines changed

Some content is hidden

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

140 files changed

+420
-552
lines changed

Sources/NodesGenerator/Resources/Stencils/Interface.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 owns_view %}
@@ -35,8 +33,6 @@ internal protocol {{ node_name }}Flow: Flow {
3533
internal protocol {{ node_name }}Flow: Flow {}
3634
{% endif %}
3735

38-
// MARK: - Builder
39-
4036
{% if is_periphery_comment_enabled %}
4137
// periphery:ignore
4238
{% endif %}

Sources/NodesGenerator/Resources/Stencils/PluginInterface.stencil

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

9-
// This file defines the protocols and types in the plugin interface requiring public ACL for use in another module.
9+
/*
10+
This file defines the protocols and types in the plugin interface requiring public ACL for use in another module.
11+
*/
1012

1113
/// Dynamic state from the caller provided to the plugin to use in determining whether it is enabled.
1214
/// - NOTE: An alias to a tuple is supported.

Sources/NodesGenerator/Resources/Stencils/PluginListInterface.stencil

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

9-
// This file defines the protocols and types in the Plugin List interface requiring public ACL for use in another module.
9+
/*
10+
This file defines the protocols and types in the plugin list interface requiring public ACL for use in another module.
11+
*/
1012

1113
/// Declares the type of key used to identify plugins within the collection.
1214
/// - NOTE: May be any ``Hashable`` type such as ``String`` or an enumeration.

Tests/NodesGeneratorTests/__Snapshots__/PresetGeneratorTests/testGenerateAppPreset.Contents-AppInterface-swift.txt

+3-5
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,14 @@
44

55
import Nodes
66

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

1111
/// @mockable
1212
@MainActor
1313
internal protocol AppFlow: Flow {}
1414

15-
// MARK: - Builder
16-
1715
/// @mockable
1816
@MainActor
1917
internal protocol AppBuilder: AnyObject {

Tests/NodesGeneratorTests/__Snapshots__/PresetGeneratorTests/testGenerateRootPreset.Contents-RootInterface-swift.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,19 @@
44

55
import Nodes
66

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

1111
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
1212
/// @mockable
1313
@MainActor
1414
internal protocol RootListener: AnyObject {}
1515

16-
// MARK: - Flow
17-
1816
/// @mockable
1917
@MainActor
2018
internal protocol RootFlow: ViewControllableFlow {}
2119

22-
// MARK: - Builder
23-
2420
/// @mockable
2521
@MainActor
2622
internal protocol RootBuilder: AnyObject {

Tests/NodesGeneratorTests/__Snapshots__/PresetGeneratorTests/testGenerateScenePreset.Contents-WindowSceneInterface-swift.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,21 @@
44

55
import Nodes
66

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

1111
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
1212
/// @mockable
1313
@MainActor
1414
internal protocol WindowSceneListener: AnyObject {}
1515

16-
// MARK: - Flow
17-
1816
/// @mockable
1917
@MainActor
2018
internal protocol WindowSceneFlow: Flow {
2119
func getViewController() -> WindowSceneViewControllable
2220
}
2321

24-
// MARK: - Builder
25-
2622
/// @mockable
2723
@MainActor
2824
internal protocol WindowSceneBuilder: AnyObject {

Tests/NodesGeneratorTests/__Snapshots__/PresetGeneratorTests/testGenerateWindowPreset.Contents-WindowInterface-swift.txt

+3-7
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,19 @@
44

55
import Nodes
66

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

1111
/// Defines the delegate protocol through which the `Context` interfaces with its listener.
1212
/// @mockable
1313
@MainActor
1414
internal protocol WindowListener: AnyObject {}
1515

16-
// MARK: - Flow
17-
1816
/// @mockable
1917
@MainActor
2018
internal protocol WindowFlow: Flow {}
2119

22-
// MARK: - Builder
23-
2420
/// @mockable
2521
@MainActor
2622
internal protocol WindowBuilder: AnyObject {

Tests/NodesGeneratorTests/__Snapshots__/StencilRendererTests/testRenderNode.Interface-AppKit-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-AppKit-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-AppKit-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-Custom-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-Custom-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-Custom-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-UIKit-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-UIKit-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-UIKit-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

0 commit comments

Comments
 (0)