Add comments for the Recordable class

algolia · Oct 31, 2018 · 04f4eb8 · 04f4eb8
1 parent 39ee428
commit 04f4eb8
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/VoiceOverlay/Protocols/Recordable.swift b/VoiceOverlay/Protocols/Recordable.swift
@@ -7,13 +7,19 @@
 
 import Foundation
 
+/// Protocol that allows to inject any STT into the voice overlay
 public protocol Recordable {
+
+  // Starting the recording and processing the STT
   func startRecording(textHandler: @escaping SpeechTextHandler, errorHandler: @escaping SpeechErrorHandler)
 
+  // Stop the recording
   func stopRecording()
 
+  // Get the state of the recording
   func isRecording() -> Bool
 
+  // Request system authorisation for STT and Voice capabilies
   func requestAuthorization(_ statusHandler: @escaping (Bool) -> Void)
 }