Move provider docs into code comments

Author: MikeChen1109

README.md

@@ -204,32 +204,6 @@ If you want to see how this package is used in practice, check the demo app in:
 
 The demo app uses `TranslationPreparationGate` at the root and shows both SwiftUI and UIKit preview screens under the same preparation flow.
 
-## Built-in Providers
-
-### `AppleTranslationProvider`
-
-Use it when you want a simpler way to integrate Apple Translate and translate strings without repeatedly wiring Apple Translation APIs yourself.
-
-Pair it with `TranslationPreparationGate` for the quickest setup, or use `TranslationPreparationCoordinator` when you need a custom preparation UI.
-
-### `PseudoLocalizationProvider`
-
-Use this when you want to stress test UI layout.
-
-It:
-
-- replaces some characters with accented versions
-- pads text length to mimic longer translations
-- adds a visible language marker around the output
-
-### `MockLocalizationProvider`
-
-Useful when you want deterministic debug output without depending on external translation behavior.
-
-### `PassthroughLocalizationProvider`
-
-Returns the original text unchanged.
-
 ## License
 
 MIT

Sources/DebugLocalizationCore/DebugLocalizationProvider.swift

@@ -1,9 +1,11 @@
 import Foundation
 
+/// A pluggable translation backend used by `DebugLocalizer` and `DebugTranslate`.
 public protocol LocalizationProvider: Sendable {
     func translate(_ text: String) async -> String
 }
 
+/// A translation provider that can return results immediately without async work.
 public protocol SyncLocalizationProvider: LocalizationProvider {
     func translateSynchronously(_ text: String) -> String
 }

Sources/DebugLocalizationCore/PseudoLocalizationProvider.swift

@@ -1,5 +1,6 @@
 import Foundation
 
+/// A sync provider that expands and accents text to stress test localized UI layout.
 public struct PseudoLocalizationProvider: SyncLocalizationProvider {
     public init() {}
 
@@ -37,6 +38,7 @@ public struct PseudoLocalizationProvider: SyncLocalizationProvider {
     }
 }
 
+/// A sync provider that returns the original text unchanged.
 public struct PassthroughLocalizationProvider: SyncLocalizationProvider {
     public init() {}
 
@@ -45,6 +47,7 @@ public struct PassthroughLocalizationProvider: SyncLocalizationProvider {
     }
 }
 
+/// A sync provider that adds the current language code to the original text for deterministic previews.
 public struct MockLocalizationProvider: SyncLocalizationProvider {
     public init() {}
 

Sources/DebugLocalizationTranslationSupport/AppleTranslationProvider.swift

@@ -4,6 +4,7 @@ import DebugLocalizationCore
 import Translation
 #endif
 
+/// A translation provider that wraps Apple Translation behind the shared localization API.
 public struct AppleTranslationProvider: LocalizationProvider, @unchecked Sendable {
     typealias AppLanguageIdentifierProvider = () -> String
     typealias EnglishLanguageIdentifierChecker = (String) -> Bool
@@ -78,6 +79,7 @@ public struct AppleTranslationProvider: LocalizationProvider, @unchecked Sendabl
 
 #if canImport(Translation)
     @available(iOS 18.0, *)
+    /// The source and target language pair resolved for Apple Translation.
     public struct Preparation: Sendable {
         public let sourceLanguage: Locale.Language
         public let targetLanguage: Locale.Language