chore: Update public comments to Swift style (#6635)

Author: noahsmartin

CHANGELOG.md

@@ -34,6 +34,7 @@
 ### Features
 
 - Add SentryDistribution as Swift Package Manager target (#6149)
+- Moves SentryClient and SentryHub to be written in Swift (#6627)
 - Add option `enablePropagateTraceparent` to support OTel/W3C trace propagation (#6356)
 - Move `enableFileManagerSwizzling` from experimental options to top-level options (#6592).
   This option is still disabled by default and will be enabled in a future major release.

Sources/Swift/SentryClient.swift

@@ -4,11 +4,9 @@ import Foundation
 @objc public final class SentryClient: NSObject {
     let helper: SentryClientInternal
 
-    /**
-     * Initializes a @c SentryClient. Pass in a dictionary of options.
-     * @param options Options dictionary
-     * @return An initialized @c SentryClient or @c nil if an error occurred.
-     */
+    /// Initializes a `SentryClient`. Pass in a dictionary of options.
+    /// - Parameter options: Options dictionary
+    /// - Returns: An initialized `SentryClient` or `nil` if an error occurred.
     @objc public init?(options: Options) {
         guard let helper = SentryClientInternal(options: options) else {
             return nil
@@ -29,87 +27,74 @@ import Foundation
         set { helper.options = newValue }
     }
 
-    /**
-     * Captures a manually created event and sends it to Sentry.
-     * @param event The event to send to Sentry.
-     * @return The @c SentryId of the event or @c SentryId.empty if the event is not sent.
-     */
+    /// Captures a manually created event and sends it to Sentry.
+    /// - Parameter event: The event to send to Sentry.
+    /// - Returns: The `SentryId` of the event or `SentryId.empty` if the event is not sent.
     @discardableResult @objc(captureEvent:) public func capture(event: Event) -> SentryId {
         helper.capture(event: event)
     }
 
-    /**
-     * Captures a manually created event and sends it to Sentry.
-     * @param event The event to send to Sentry.
-     * @param scope The scope containing event metadata.
-     * @return The @c SentryId of the event or @c SentryId.empty if the event is not sent.
-     */
+    /// Captures a manually created event and sends it to Sentry.
+    /// - Parameters:
+    ///   - event: The event to send to Sentry.
+    ///   - scope: The scope containing event metadata.
+    /// - Returns: The `SentryId` of the event or `SentryId.empty` if the event is not sent.
     @discardableResult @objc(captureEvent:withScope:) public func capture(event: Event, scope: Scope) -> SentryId {
         helper.capture(event: event, scope: scope)
     }
 
-    /**
-     * Captures an error event and sends it to Sentry.
-     * @param error The error to send to Sentry.
-     * @return The @c SentryId of the event or @c SentryId.empty if the event is not sent.
-     */
+    /// Captures an error event and sends it to Sentry.
+    /// - Parameter error: The error to send to Sentry.
+    /// - Returns: The `SentryId` of the event or `SentryId.empty` if the event is not sent.
     @discardableResult @objc(captureError:) public func capture(error: Error) -> SentryId {
         helper.capture(error: error)
     }
 
-    /**
-     * Captures an error event and sends it to Sentry.
-     * @param error The error to send to Sentry.
-     * @param scope The scope containing event metadata.
-     * @return The @c SentryId of the event or @c SentryId.empty if the event is not sent.
-     */
+    /// Captures an error event and sends it to Sentry.
+    /// - Parameters:
+    ///   - error: The error to send to Sentry.
+    ///   - scope: The scope containing event metadata.
+    /// - Returns: The `SentryId` of the event or `SentryId.empty` if the event is not sent.
     @discardableResult @objc(captureError:withScope:) public func capture(error: Error, scope: Scope) -> SentryId {
         helper.capture(error: error, scope: scope)
     }
 
-    /**
-     * Captures an exception event and sends it to Sentry.
-     * @param exception The exception to send to Sentry.
-     * @return The @c SentryId of the event or @c SentryId.empty if the event is not sent.
-     */
+    /// Captures an exception event and sends it to Sentry.
+    /// - Parameter exception: The exception to send to Sentry.
+    /// - Returns: The `SentryId` of the event or `SentryId.empty` if the event is not sent.
     @discardableResult @objc(captureException:) public func capture(exception: NSException) -> SentryId {
         helper.capture(exception: exception)
     }
 
-    /**
-     * Captures an exception event and sends it to Sentry.
-     * @param exception The exception to send to Sentry.
-     * @param scope The scope containing event metadata.
-     * @return The @c SentryId of the event or @c SentryId.empty if the event is not sent.
-     */
+    /// Captures an exception event and sends it to Sentry.
+    /// - Parameters:
+    ///   - exception: The exception to send to Sentry.
+    ///   - scope: The scope containing event metadata.
+    /// - Returns: The `SentryId` of the event or `SentryId.empty` if the event is not sent.
     @discardableResult @objc(captureException:withScope:) public func capture(exception: NSException, scope: Scope) -> SentryId {
         helper.capture(exception: exception, scope: scope)
     }
 
-    /**
-     * Captures a message event and sends it to Sentry.
-     * @param message The message to send to Sentry.
-     * @return The @c SentryId of the event or @c SentryId.empty if the event is not sent.
-     */
+    /// Captures a message event and sends it to Sentry.
+    /// - Parameter message: The message to send to Sentry.
+    /// - Returns: The `SentryId` of the event or `SentryId.empty` if the event is not sent.
     @discardableResult @objc(captureMessage:) public func capture(message: String) -> SentryId {
         helper.capture(message: message)
     }
 
-    /**
-     * Captures a message event and sends it to Sentry.
-     * @param message The message to send to Sentry.
-     * @param scope The scope containing event metadata.
-     * @return The @c SentryId of the event or @c SentryId.empty if the event is not sent.
-     */
+    /// Captures a message event and sends it to Sentry.
+    /// - Parameters:
+    ///   - message: The message to send to Sentry.
+    ///   - scope: The scope containing event metadata.
+    /// - Returns: The `SentryId` of the event or `SentryId.empty` if the event is not sent.
     @discardableResult @objc(captureMessage:withScope:) public func capture(message: String, scope: Scope) -> SentryId {
         helper.capture(message: message, scope: scope)
     }
 
-    /**
-     * Captures a new-style user feedback and sends it to Sentry.
-     * @param feedback The user feedback to send to Sentry.
-     * @param scope The current scope from which to gather contextual information.
-     */
+    /// Captures a new-style user feedback and sends it to Sentry.
+    /// - Parameters:
+    ///   - feedback: The user feedback to send to Sentry.
+    ///   - scope: The current scope from which to gather contextual information.
     @objc(captureFeedback:withScope:) public func capture(feedback: SentryFeedback, scope: Scope) {
         helper.captureSerializedFeedback(
           feedback.serialize(),
@@ -118,19 +103,14 @@ import Foundation
           scope: scope)
     }
 
-    /**
-     * Waits synchronously for the SDK to flush out all queued and cached items for up to the specified
-     * timeout in seconds. If there is no internet connection, the function returns immediately. The SDK
-     * doesn't dispose the client or the hub.
-     * @param timeout The time to wait for the SDK to complete the flush.
-     */
+    /// Waits synchronously for the SDK to flush out all queued and cached items for up to the specified timeout in seconds.
+    /// If there is no internet connection, the function returns immediately. The SDK doesn't dispose the client or the hub.
+    /// - Parameter timeout: The time to wait for the SDK to complete the flush.
     @objc(flush:) public func flush(timeout: TimeInterval) {
         helper.flush(timeout: timeout)
     }
 
-    /**
-     * Disables the client and calls flush with @c SentryOptions.shutdownTimeInterval .
-     */
+    /// Disables the client and calls flush with `SentryOptions.shutdownTimeInterval`.
     @objc public func close() {
         helper.close()
     }