docs: restore helper header comments

Restore the four headerdocs this branch had dropped from
SentryUIViewControllerSwizzlingHelper.h, and keep the new notes as
additions to them rather than replacements.

Drop the now-unused _SentryPrivate import from ClearTestState: the
helper's stop moved to the swizzling suite's tearDown, so the file no
longer references it.

Author: philipphofmann

SentryTestUtils/Sources/ClearTestState.swift

@@ -1,5 +1,4 @@
 @_spi(Private) @testable import Sentry
-import _SentryPrivate
 import Foundation
 
 public func clearTestState() {

Sources/Sentry/include/SentryUIViewControllerSwizzlingHelper.h

@@ -4,11 +4,23 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/**
+ * Helper class that performs the actual method swizzling for UIViewController tracking.
+ * This class is used by the Swift SentryUIViewControllerSwizzling class.
+ */
 @interface SentryUIViewControllerSwizzlingHelper : NSObject
 
+/**
+ * Swizzles the base UIViewController methods (loadView) with the provided tracker.
+ * @param tracker The performance tracker to use for tracking view controller lifecycle events.
+ */
 + (void)swizzleUIViewControllerWithTracker:(SENTRY_SWIFT_MIGRATION_ID(
                                                SentryUIViewControllerPerformanceTracker))tracker;
 
+/**
+ * Swizzles a specific UIViewController subclass for performance tracking.
+ * @param class The UIViewController subclass to swizzle.
+ */
 + (void)swizzleViewControllerSubClass:(Class)class;
 
 /**
@@ -29,12 +41,17 @@ NS_ASSUME_NONNULL_BEGIN
 #    if SENTRY_TEST || SENTRY_TEST_CI
 
 /**
+ * Unswizzles all UIViewController methods. Only available in test targets.
+ *
  * Restores @c loadView and the two init funnel initializers. Restoring the initializers matters
  * because a live base-class IMP outlives the delegate that @c stop clears, so leaving them
  * installed leaks the funnel into every later test suite in the same run.
  */
 + (void)unswizzle;
 
+/**
+ * Returns whether swizzling is currently active. Only available in test targets.
+ */
 + (BOOL)swizzlingActive;
 #    endif