Remove “purpose” from all comments (#876)

Author: tinder-cfuller

Sources/NodesGenerator/Resources/Stencils/Analytics.stencil

@@ -17,14 +17,12 @@ import {{ import }}
  *
  */
 
-/// PURPOSE:
 /// The interface for analytics tracked by this Node.
 ///
 /// Add requirements to this protocol to provide analytics tracking methods for this Node.
 /// @mockable
 internal protocol {{ node_name }}Analytics: AnyObject {}
 
-/// PURPOSE:
 /// Custom analytics implementation for this Node.
 {% if analytics_properties %}
 internal final class {{ node_name }}AnalyticsImp {

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

@@ -6,7 +6,6 @@ import {{ import }}
 {% endfor %}
 {% endif %}
 
-/// PURPOSE:
 /// The interface of the Flow.
 /// @mockable
 @MainActor
@@ -16,7 +15,6 @@ internal protocol {{ node_name }}Flow: {{ plugin_list_name }}Flow {}
 internal protocol {{ node_name }}Flow: {{ view_controllable_flow_type }} {}
 {% endif %}
 
-/// PURPOSE:
 /// Declares the dependencies required by this Node that will be injected (not created by this Node itself).
 /// @mockable
 @MainActor
@@ -30,21 +28,18 @@ public protocol {{ node_name }}Dependency: Dependency {
 public protocol {{ node_name }}Dependency: Dependency {}
 {% endif %}
 
-/// PURPOSE:
 /// A dependency needed by the Builder (such as a Listener), passed in from the caller (i.e. is not on the DI graph).
 ///
 /// Can be a tuple or struct containing multiple values when necessary.
 internal typealias {{ node_name }}DynamicBuildDependency = {{ node_name }}Listener
 
-/// PURPOSE:
 /// A dependency used by the Component itself, passed into the Component's initializer (in the Component factory).
 ///
 /// Can be a tuple or struct containing multiple values when necessary.
 internal typealias {{ node_name }}DynamicComponentDependency = Void
 
 // MARK: - Component
 
-/// PURPOSE:
 /// Declares dependencies that are owned by this Node.
 public final class {{ node_name }}Component: Component
 <
@@ -121,7 +116,6 @@ public final class {{ node_name }}Component: Component
 {% if is_periphery_comment_enabled %}
 // periphery:ignore
 {% endif %}
-/// PURPOSE:
 /// The Builder interface (available to mock for testability).
 /// @mockable
 @MainActor
@@ -138,7 +132,6 @@ internal protocol {{ node_name }}Builder: AnyObject {
 {% if is_periphery_comment_enabled %}
 // periphery:ignore
 {% endif %}
-/// PURPOSE:
 /// Concrete implementation of the Builder, where everything is created and associated.
 internal final class {{ node_name }}BuilderImp: AbstractBuilder
 <

Sources/NodesGenerator/Resources/Stencils/Builder.stencil

@@ -6,7 +6,6 @@ import {{ import }}
 {% endfor %}
 {% endif %}
 
-/// PURPOSE:
 /// The interface of the Flow.
 /// @mockable
 @MainActor
@@ -25,7 +24,6 @@ internal protocol {{ node_name }}Flow: Flow {}
 {% endif %}
 {% if node_name != "App" %}
 
-/// PURPOSE:
 /// Declares the dependencies required by this Node that will be injected (not created by this Node itself).
 /// @mockable
 @MainActor
@@ -40,7 +38,6 @@ public protocol {{ node_name }}Dependency: Dependency {}
 {% endif %}
 {% endif %}
 
-/// PURPOSE:
 /// A dependency needed by the Builder (such as a Listener), passed in from the caller (i.e. is not on the DI graph).
 ///
 /// Can be a tuple or struct containing multiple values when necessary.
@@ -52,15 +49,13 @@ internal typealias {{ node_name }}DynamicBuildDependency = Void
 internal typealias {{ node_name }}DynamicBuildDependency = ({{ node_name }}Listener, {{ node_name }}ViewControllable)
 {% endif %}
 
-/// PURPOSE:
 /// A dependency used by the Component itself, passed into the Component's initializer (in the Component factory).
 ///
 /// Can be a tuple or struct containing multiple values when necessary.
 internal typealias {{ node_name }}DynamicComponentDependency = Void
 
 // MARK: - Component
 
-/// PURPOSE:
 /// Declares dependencies that are owned by this Node.
 {% if node_name == "App" %}
 public final class {{ node_name }}Component: BootstrapComponent {
@@ -167,7 +162,6 @@ public final class {{ node_name }}Component: Component
 {% if is_periphery_comment_enabled %}
 // periphery:ignore
 {% endif %}
-/// PURPOSE:
 /// The Builder interface (available to mock for testability).
 /// @mockable
 @MainActor
@@ -193,7 +187,6 @@ internal protocol {{ node_name }}Builder: AnyObject {
 {% if is_periphery_comment_enabled %}
 // periphery:ignore
 {% endif %}
-/// PURPOSE:
 /// Concrete implementation of the Builder, where everything is created and associated.
 internal final class {{ node_name }}BuilderImp: AbstractBuilder
 <

Sources/NodesGenerator/Resources/Stencils/Context.stencil

@@ -7,14 +7,12 @@ import {{ import }}
 {% endif %}
 {% if node_name != "App" %}
 
-/// PURPOSE:
 /// The Context delegates callbacks to its (external) Listener, typically the parent Context.
 /// @mockable
 @MainActor
 internal protocol {{ node_name }}Listener: AnyObject {}
 {% endif %}
 
-/// PURPOSE:
 /// The interface that the Context will speak to the Flow through. Used to initiate navigation as
 /// an example.
 /// @mockable
@@ -32,7 +30,6 @@ internal protocol {{ node_name }}FlowInterface: Flow {
 internal protocol {{ node_name }}FlowInterface: Flow {}
 {% endif %}
 
-/// PURPOSE:
 /// Contains the business logic of the Node. The lifecycle of the Node is bookended between the
 /// `didBecomeActive` and `willResignActive` methods.
 {% if context_generic_types %}

Sources/NodesGenerator/Resources/Stencils/Flow.stencil

@@ -6,7 +6,6 @@ import {{ import }}
 {% endfor %}
 {% endif %}
 
-/// PURPOSE:
 /// The interface that the Flow will speak to the Context through. Used for informing the Context of
 /// presentation lifecycle events, as an example.
 /// @mockable
@@ -20,7 +19,6 @@ internal protocol {{ node_name }}ContextInterface: Context, RootListener {}
 {% else %}
 internal protocol {{ node_name }}ContextInterface: Context {}
 
-/// PURPOSE:
 /// The interface of the View used for presenting the View of child Nodes. May inherit additional base
 /// protocols to add further pre-baked presentation behavior and/or add new methods for custom presentation
 /// implementation as necessary.
@@ -31,7 +29,6 @@ internal protocol {{ node_name }}ContextInterface: Context {}
 internal protocol {{ node_name }}ViewControllable: {{ view_controllable_type }} {}
 {% endif %}
 
-/// PURPOSE:
 /// Responsible for presenting views and starting child Flows, and should not contain business logic.
 internal final class {{ node_name }}FlowImp: AbstractFlow
 <

Sources/NodesGenerator/Resources/Stencils/Plugin.stencil

@@ -6,13 +6,11 @@ import {{ import }}
 {% endfor %}
 {% endif %}
 
-/// PURPOSE:
 /// Declares the dependencies required by this Plugin that will be injected (not created by this Plugin itself).
 /// @mockable
 @MainActor
 public protocol {{ plugin_name }}PluginDependency: Dependency {}
 
-/// PURPOSE:
 /// Declares dependencies that are owned by this Plugin.
 public final class {{ plugin_name }}PluginComponent: Component
 <
@@ -61,14 +59,12 @@ public final class {{ plugin_name }}PluginComponent: Component
     }
 }
 
-/// PURPOSE:
 /// To provide additional state used in determining if the Plugin is enabled (can be any type relevant to the Plugin).
 internal typealias {{ plugin_name }}PluginStateType = Void
 
 {% if is_periphery_comment_enabled %}
 // periphery:ignore
 {% endif %}
-/// PURPOSE:
 /// The Plugin interface (available to mock for testability).
 /// @mockable
 @MainActor
@@ -79,7 +75,6 @@ internal protocol {{ plugin_name }}Plugin {
 {% if is_periphery_comment_enabled %}
 // periphery:ignore
 {% endif %}
-/// PURPOSE:
 /// Concrete implementation of the Plugin.
 internal final class {{ plugin_name }}PluginImp: Plugin
 <

Sources/NodesGenerator/Resources/Stencils/PluginList.stencil

@@ -9,7 +9,6 @@ import {{ import }}
 {% if is_periphery_comment_enabled %}
 // periphery:ignore
 {% endif %}
-/// PURPOSE:
 /// The common Flow interface.
 /// @mockable
 @MainActor
@@ -18,7 +17,6 @@ internal protocol {{ plugin_list_name }}Flow: {{ view_controllable_flow_type }}
 {% if is_periphery_comment_enabled %}
 // periphery:ignore
 {% endif %}
-/// PURPOSE:
 /// The common Listener interface.
 /// @mockable
 @MainActor
@@ -27,7 +25,6 @@ internal protocol {{ plugin_list_name }}Listener: AnyObject {}
 {% if is_periphery_comment_enabled %}
 // periphery:ignore
 {% endif %}
-/// PURPOSE:
 /// The common Builder interface.
 /// @mockable
 @MainActor
@@ -37,13 +34,11 @@ internal protocol {{ plugin_list_name }}Builder: AnyObject {
     ) -> {{ plugin_list_name }}Flow
 }
 
-/// PURPOSE:
 /// Declares the dependencies required by this Plugin List that will be injected (not created by this Plugin List itself).
 /// @mockable
 @MainActor
 public protocol {{ plugin_list_name }}PluginListDependency: Dependency {}
 
-/// PURPOSE:
 /// Declares dependencies that are owned by this Plugin List.
 public final class {{ plugin_list_name }}PluginListComponent: Component
 <
@@ -88,18 +83,15 @@ public final class {{ plugin_list_name }}PluginListComponent: Component
      */
 }
 
-/// PURPOSE:
 /// The type used for the keys of the Plugin List (can be any `Hashable` type such as `String` or an enumeration).
 internal typealias {{ plugin_list_name }}PluginListKeyType = String
 
-/// PURPOSE:
 /// To provide additional state used in determining if the plugins are enabled (can be any type relevant to the plugins).
 internal typealias {{ plugin_list_name }}PluginListStateType = Void
 
 {% if is_periphery_comment_enabled %}
 // periphery:ignore
 {% endif %}
-/// PURPOSE:
 /// The Plugin List protocol (available to mock for testability).
 /// @mockable
 @MainActor
@@ -112,7 +104,6 @@ internal protocol {{ plugin_list_name }}PluginList {
 {% if is_periphery_comment_enabled %}
 // periphery:ignore
 {% endif %}
-/// PURPOSE:
 /// Concrete implementation of the Plugin List providing the Plugin collection and (optionally) the creation order.
 internal final class {{ plugin_list_name }}PluginListImp: PluginList
 <

Sources/NodesGenerator/Resources/Stencils/State.stencil

@@ -6,7 +6,6 @@ import {{ import }}
 {% endfor %}
 {% endif %}
 
-/// PURPOSE:
 /// The state of the Node.
 internal struct {{ node_name }}State: Equatable {
 

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

@@ -6,14 +6,12 @@ import {{ import }}
 {% endfor %}
 {% endif %}
 
-/// PURPOSE:
 /// The interface that the View will speak to the Context through. Used for informing the Context of
 /// view events and user interactions.
 /// @mockable
 @MainActor
 internal protocol {{ node_name }}Receiver: AnyObject {}
 
-/// PURPOSE:
 /// Host of the SwiftUI view.
 internal final class {{ node_name }}ViewController: {{ view_controller_type }}
 <
@@ -35,7 +33,6 @@ internal final class {{ node_name }}ViewController: {{ view_controller_type }}
 
 extension {{ node_name }}ViewController: {{ node_name }}ViewControllable {}
 
-/// PURPOSE:
 /// Concrete implementation of the View.
 internal struct {{ node_name }}View {
 
@@ -78,7 +75,6 @@ extension {{ node_name }}View: View {
 {% if is_periphery_comment_enabled %}
 // periphery:ignore
 {% endif %}
-/// PURPOSE:
 /// The SwiftUI preview (excluded from release builds).
 internal struct {{ node_name }}View_Previews: PreviewProvider {
 

Sources/NodesGenerator/Resources/Stencils/ViewController.stencil

@@ -6,7 +6,6 @@ import {{ import }}
 {% endfor %}
 {% endif %}
 
-/// PURPOSE:
 /// The interface that the View will speak to the Context through. Used for informing the Context of
 /// view events and user interactions.
 /// @mockable
@@ -19,7 +18,6 @@ internal protocol {{ node_name }}Receiver: AnyObject {
 internal protocol {{ node_name }}Receiver: AnyObject {}
 {% endif %}
 
-/// PURPOSE:
 /// Concrete implementation of the UI.
 internal final class {{ node_name }}ViewController: {{ view_controller_type }}, StateObserver {
     {% if view_controller_static_content %}