Adding documentation note for fixed strategy concerning iOS protected…

… data feature.
tonystone · Sep 12, 2019 · 6ef0805 · 6ef0805
1 parent ded9583
commit 6ef0805
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/Sources/TraceLog/Writers & Formatters/FileWriter.swift b/Sources/TraceLog/Writers & Formatters/FileWriter.swift
@@ -191,6 +191,11 @@ extension FileWriter {
         ///         with this option, TraceLog will continue
         ///         to append to the file name specified.
         ///
+        /// - Note: On the iOS platform, this strategy will monitor protected data availability
+        ///         and if you use the `ConcurrencyMode.async` mode with the
+        ///         `AsyncConcurrencyModeOption.buffer(writeInterval:strategy:)` the FileWriter will
+        ///         buffer when protected data is not available.
+        ///
         /// - Remark: Once Swift Evolution [SE-0155](https://github.com/apple/swift-evolution/blob/master/proposals/0155-normalize-enum-case-representation.md) is implemented
         ///           this will func will be changed to a case in the enum with default values.  We must
         ///           use a func now to work around the lack of defaults on enums.