Add complete API documentation, fixes #9

fulldecent · Jun 28, 2016 · 1010e71 · 1010e71
1 parent 052d55a
commit 1010e71
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,9 @@ All notable changes to this project will be documented in this file.
 ## [Master](https://github.com/fulldecent/FDSoundActivatedRecorder/compare/1.0.5...master)
 
 #### Added
+- Complete API documentation
+  - Added by [William Entriken](https://github.com/fulldecent) in Regards to Issue
+  [#9](https://github.com/fulldecent/FDSoundActivatedRecorder/issues/9).
 - Swift Package Masager support
   - Added by [William Entriken](https://github.com/fulldecent) in Regards to Issue
   [#8](https://github.com/fulldecent/FDSoundActivatedRecorder/issues/8).

diff --git a/FDSoundActivatedRecorder/FDSoundActivatedRecorder/FDSoundActivatedRecorder.swift b/FDSoundActivatedRecorder/FDSoundActivatedRecorder/FDSoundActivatedRecorder.swift
@@ -59,6 +59,7 @@ private enum FDSoundActivatedRecorderStatus: Int {
     case ProcessingRecording
 }
 
+/// An automated listener / recorder
 public class FDSoundActivatedRecorder: NSObject, AVAudioRecorderDelegate {
     private let TOTAL_TIMEOUT_SECONDS = 10.0
     /// A time interval in seconds to base all `INTERVALS` below