doc(voice): add swift docs to all customisation options

Also some refactoring (extracting methods)

VoiceOverlay-Demo/VoiceOverlay-Demo/ViewController.swift

@@ -30,7 +30,7 @@ class ViewController: UIViewController, VoiceOverlayDelegate {
         // If you want to start recording as soon as modal view pops up, change to true
         voiceOverlayController.settings.autoStart = true
         voiceOverlayController.settings.autoStop = true
-        voiceOverlayController.settings.showResultScreen = false
+        voiceOverlayController.settings.showResultScreen = true
         //voiceOverlayController.settings.layout.recordingScreen.titleListening = "custom title when listening"
 
     }

VoiceOverlay/Controllers/NoPermissionViewController.swift

@@ -49,7 +49,7 @@ public class NoPermissionViewController: UIViewController {
 
         if UIApplication.shared.canOpenURL(settingsUrl) {
             UIApplication.shared.open(settingsUrl, completionHandler: { (success) in
-                print("Settings opened: \(success)") // Prints true
+
             })
         }
     }

VoiceOverlay/Controllers/PermissionViewController.swift

@@ -9,7 +9,7 @@
 import UIKit
 import AVFoundation
 
-public class PermissionViewController: UIViewController {
+class PermissionViewController: UIViewController {
 
     var dismissHandler: (() -> ())? = nil
     var speechController: SpeechController!

VoiceOverlay/Controllers/RecordingViewController.swift

@@ -66,9 +66,7 @@ class RecordingViewController: UIViewController {
     }
   }
 
-  // handle notification
   @objc func resultScreenTextReceived(_ notification: NSNotification) {
-
     if let resultScreenText = notification.userInfo?["resultScreenText"] as? NSAttributedString {
       guard let resultViewController = resultViewController else { return }
       resultScreentimer?.invalidate()
@@ -100,7 +98,7 @@ class RecordingViewController: UIViewController {
       self.dismissHandler?(false)
     }
   }
-
+  
   func toggleRecording(_ recordingButton: RecordingButton, dismiss: Bool = true) {
     isRecording = !isRecording
     recordingButton.animate(isRecording)
@@ -122,24 +120,7 @@ class RecordingViewController: UIViewController {
       if dismiss {
         if settings.showResultScreen {
           resultViewController = ResultViewController()
-          guard let resultViewController = resultViewController else { return }
-          resultViewController.dismissHandler = { [unowned self] (retry) in
-            self.resultScreentimer?.invalidate()
-            self.resultViewController?.dismissMe(animated: false) {
-              self.dismissMe(animated: false) {
-                self.dismissHandler?(true)
-              }
-            }
-          }
-          resultViewController.constants = self.settings.layout.resultScreen
-          self.present(resultViewController, animated: false)
-          resultScreentimer = Timer.scheduledTimer(withTimeInterval: self.settings.showResultScreenTimeout, repeats: false, block: { (_) in
-            self.resultViewController?.dismissMe(animated: false) {
-              self.dismissMe(animated: false) {
-                self.dismissHandler?(false)
-              }
-            }
-          })
+          setup(resultViewController!)
         } else {
           dismissMe(animated: true) {
             self.dismissHandler?(false)
@@ -189,6 +170,26 @@ class RecordingViewController: UIViewController {
     })
   }
 
+  fileprivate func setup(_ resultViewController: ResultViewController) {
+    resultViewController.dismissHandler = { [unowned self] (retry) in
+      self.resultScreentimer?.invalidate()
+      self.resultViewController?.dismissMe(animated: false) {
+        self.dismissMe(animated: false) {
+          self.dismissHandler?(true)
+        }
+      }
+    }
+    resultViewController.constants = self.settings.layout.resultScreen
+    self.present(resultViewController, animated: false)
+    resultScreentimer = Timer.scheduledTimer(withTimeInterval: self.settings.showResultScreenTimeout, repeats: false, block: { (_) in
+      self.resultViewController?.dismissMe(animated: false) {
+        self.dismissMe(animated: false) {
+          self.dismissHandler?(false)
+        }
+      }
+    })
+  }
+
   func handleVoiceError(_ error: Error?) {
     titleLabel.text = constants.titleError
     subtitleLabel.text = constants.subtitleError

VoiceOverlay/Controllers/ResultViewController.swift

@@ -18,6 +18,7 @@ public class ResultViewController: UIViewController {
   let subtitleLabel = UILabel()
   let startAgainButton = UIButton()
 
+  // The bool specifies whether we dismiss with retry or not
   var dismissHandler: ((Bool) -> ())? = nil
 
   var voiceOutputText: NSAttributedString? {

VoiceOverlay/Controllers/VoiceOverlayController.swift

@@ -10,6 +10,7 @@ import Foundation
 import UIKit
 import Speech
 
+/// Controller that takes care of launching a voice overlay and providing handlers to listen to text and error events.
 public class VoiceOverlayController {
 
     let permissionViewController = PermissionViewController()
@@ -22,11 +23,9 @@ public class VoiceOverlayController {
     public var settings: VoiceUISettings = VoiceUISettings()
     var recordingViewController: RecordingViewController? = RecordingViewController()
 
-
-    public init() {}
-
-    // TODO: Define datasource that will be used to give back the text from the SpeechController
     public var datasource: Any? = nil
+
+    public init() {}
 
     public func start(on view: UIViewController, textHandler: @escaping SpeechTextHandler, errorHandler: @escaping SpeechErrorHandler) {
         self.speechTextHandler = textHandler
@@ -59,7 +58,7 @@ public class VoiceOverlayController {
         }
     }
 
-    func checkSpeechAuthorizationStatusAndRedirectToCorrectScreen(_ view: UIViewController) {
+    fileprivate func checkSpeechAuthorizationStatusAndRedirectToCorrectScreen(_ view: UIViewController) {
 
         // speech permissions
         switch SFSpeechRecognizer.authorizationStatus() {

VoiceOverlay/Helpers/Constant.swift

@@ -10,15 +10,28 @@ import Foundation
 import CoreGraphics
 import UIKit
 
+/// Customisation Settings for the Voice Overlay
 public class VoiceUISettings {
 
-  public var autoStart = false
+  /// Specifies whether the overlay directly starts recording (true), or if it requires the user to click the mic (false).
+  public var autoStart = true
+
+  /// Specifies whether the overlay stops recording after the user stops talking for `autoStopTimeout` seconds (true), or if it requires the user to click the mic (false).
   public var autoStop = true
+
+  /// when autoStop is set to true, autoStopTimeout determines the amount of silence time before the user stops talking.
+  public var autoStopTimeout: TimeInterval = 2
+
+  /// Whether or not to show a result screen after the recording is finished.
   public var showResultScreen = false
+
+  /// Timeout for showing the result screen in case no resultScreenText is provided on time.
   public var showResultScreenTimeout: TimeInterval = 2
+
+  /// Time for showing the result screen with the provided resultScreenText.
   public var showResultScreenTime: TimeInterval = 4
-  public var autoStopTimeout: TimeInterval = 2
-  public var layout: Layout = Layout()
+
+  /// The processed result screen text that should be appear in the result screen.
   public var resultScreenText: NSAttributedString? {
     didSet {
       if let resultScreenText = resultScreenText {
@@ -27,6 +40,9 @@ public class VoiceUISettings {
     }
   }
 
+  /// The layout and style of all screens of the voice overlay.
+  public var layout: Layout = Layout()
+
   public class Layout {
 
     public var permissionScreen = PermissionScreenConstants()