Update some docs

StanfordSpezi · Jul 10, 2024 · 18b4922 · 18b4922
1 parent b1af832
commit 18b4922
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 15 deletions.
diff --git a/Sources/Spezi/Capabilities/Lifecycle/LifecycleHandler.swift b/Sources/Spezi/Capabilities/Lifecycle/LifecycleHandler.swift
@@ -138,28 +138,22 @@ public protocol LifecycleHandler {
 )
 extension LifecycleHandler {
 #if os(iOS) || os(visionOS) || os(tvOS)
-    // A documentation for this method exists in the `LifecycleHandler` type which SwiftLint doesn't recognize.
-    // swiftlint:disable:next missing_docs
+    /// Empty default implementation.
     public func willFinishLaunchingWithOptions(_ application: UIApplication, launchOptions: [UIApplication.LaunchOptionsKey: Any]) {}
 
-    // A documentation for this method exists in the `LifecycleHandler` type which SwiftLint doesn't recognize.
-    // swiftlint:disable:next missing_docs
+    /// Empty default implementation.
     public func sceneWillEnterForeground(_ scene: UIScene) { }
 
-    // A documentation for this method exists in the `LifecycleHandler` type which SwiftLint doesn't recognize.
-    // swiftlint:disable:next missing_docs
+    /// Empty default implementation.
     public func sceneDidBecomeActive(_ scene: UIScene) { }
 
-    // A documentation for this method exists in the `LifecycleHandler` type which SwiftLint doesn't recognize.
-    // swiftlint:disable:next missing_docs
+    /// Empty default implementation.
     public func sceneWillResignActive(_ scene: UIScene) { }
 
-    // A documentation for this method exists in the `LifecycleHandler` type which SwiftLint doesn't recognize.
-    // swiftlint:disable:next missing_docs
+    /// Empty default implementation.
     public func sceneDidEnterBackground(_ scene: UIScene) { }
 
-    // A documentation for this method exists in the `LifecycleHandler` type which SwiftLint doesn't recognize.
-    // swiftlint:disable:next missing_docs
+    /// Empty default implementation.
     public func applicationWillTerminate(_ application: UIApplication) { }
 #endif
 }

diff --git a/Sources/Spezi/Module/Module.swift b/Sources/Spezi/Module/Module.swift
@@ -12,7 +12,7 @@ import SpeziFoundation
 // note: detailed documentation is provided as an article extension in the DocC bundle
 /// A `Module` defines a software subsystem that can be configured as part of the ``SpeziAppDelegate/configuration``.
 public protocol Module: AnyObject, KnowledgeSource<SpeziAnchor> {
-    /// The ``Module/configure()-5pa83`` method is called on the initialization of the Spezi instance to perform a lightweight configuration of the module.
+    /// Called on the initialization of the Spezi instance to perform a lightweight configuration of the module.
     ///
     /// It is advised that longer setup tasks are done in an asynchronous task and started during the call of the configure method.
     @MainActor
@@ -21,7 +21,8 @@ public protocol Module: AnyObject, KnowledgeSource<SpeziAnchor> {
 
 
 extension Module {
-    // A documentation for this method exists in the `Module` type which SwiftLint doesn't recognize.
-    // swiftlint:disable:next missing_docs
+    /// Empty configuration method.
+    ///
+    /// No operation.
     public func configure() {}
 }