Small improvements

StanfordSpezi · Feb 21, 2024 · fed1f0c · fed1f0c
1 parent 8888ab0
commit fed1f0c
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 9 deletions.
diff --git a/Sources/SpeziChat/ChatView+SpeechButton.swift b/Sources/SpeziChat/ChatView+SpeechButton.swift
@@ -10,7 +10,7 @@ import SwiftUI
 
 
 /// The underlying `ViewModifier` of `View/speechToolbarButton(enabled:muted:)`.
-struct ChatViewSpeechButtonModifier: ViewModifier {
+private struct ChatViewSpeechButtonModifier: ViewModifier {
     let enabled: Bool
     @Binding var muted: Bool
 

diff --git a/Sources/SpeziChat/ChatView+SpeechOutput.swift b/Sources/SpeziChat/ChatView+SpeechOutput.swift
@@ -10,8 +10,8 @@ import SpeziSpeechSynthesizer
 import SwiftUI
 
 
-/// The underlying `ViewModifier` of ``ChatView/speak(_:muted:)``.
-struct ChatViewSpeechModifier: ViewModifier {
+/// The underlying `ViewModifier` of `View/speak(_:muted:)`.
+private struct ChatViewSpeechModifier: ViewModifier {
     let chat: Chat
     let muted: Bool
 
@@ -53,7 +53,7 @@ struct ChatViewSpeechModifier: ViewModifier {
 }
 
 
-extension ChatView {
+extension View {
     /// Provides text-to-speech capabilities to the ``ChatView``.
     ///
     /// Attaching the modifier to a ``ChatView`` will enable the automatic speech output of the latest added ``ChatEntity/Role-swift.enum/assistant`` ``Chat`` message that is ``ChatEntity/complete``.

diff --git a/Sources/SpeziChat/ChatView.swift b/Sources/SpeziChat/ChatView.swift
@@ -39,7 +39,7 @@ import SwiftUI
 /// 
 /// Speech-to-text capabilities can be activated via the `speechToText` `Bool` parameter in ``init(_:disableInput:speechToText:exportFormat:messagePlaceholder:messagePendingAnimation:)``. By default, this capability is activated and therefore a small microphone button is shown next to the text input field.
 ///
-/// Text-to-speech capabilities can be configured via the ``ChatView/speak(_:muted:)`` `ViewModifier`. If present, the latest ``ChatEntity/complete`` ``ChatEntity/Role-swift.enum/assistant`` message in the ``Chat`` will be synthesized to natural language speech.
+/// Text-to-speech capabilities can be configured via the `View/speak(_:muted:)` `ViewModifier`. If present, the latest ``ChatEntity/complete`` ``ChatEntity/Role-swift.enum/assistant`` message in the ``Chat`` will be synthesized to natural language speech.
 /// In addition, the `View/speechToolbarButton(enabled:muted:)` `ViewModifier` automatically adds a toolbar `Button` to mute or unmute the speech synthesizer, if not disabled via the `enabled` parameter.
 /// The `muted` flag enables to track the state of the `Button` or adjust it from the outside.
 ///

diff --git a/Sources/SpeziChat/SpeziChat.docc/SpeziChat.md b/Sources/SpeziChat/SpeziChat.docc/SpeziChat.md
@@ -162,7 +162,3 @@ struct MessageInputTestView: View {
 
 - ``MessageInputView``
 - ``MessageInputViewHeightKey``
-
-### Accessibility
-
-- ``ChatView/speak(_:muted:)``