IOS-1540 Better docs. IOS-1540_GOOD
authorDirk Zimmermann <dz@pep.security>
Wed, 12 Jun 2019 16:37:58 +0200
branchIOS-1540_GOOD
changeset 907050a538733c10
parent 9069 388883d94c8c
child 9071 010328b9ecbc
IOS-1540 Better docs.
Submodules/pEpIOSToolbox/pEpIOSToolbox/Other/Logger.swift
     1.1 --- a/Submodules/pEpIOSToolbox/pEpIOSToolbox/Other/Logger.swift	Wed Jun 12 16:37:58 2019 +0200
     1.2 +++ b/Submodules/pEpIOSToolbox/pEpIOSToolbox/Other/Logger.swift	Wed Jun 12 16:37:58 2019 +0200
     1.3 @@ -17,6 +17,7 @@
     1.4      }
     1.5  
     1.6      /// Use for warnings, anything that might cause trouble.
     1.7 +    /// - Note: Gets persisted, so a later sysinfo on the device will recover it.
     1.8      public func warn(function: String = #function,
     1.9                       filePath: String = #file,
    1.10                       fileLine: Int = #line,
    1.11 @@ -30,8 +31,10 @@
    1.12                  args: args)
    1.13      }
    1.14  
    1.15 -    /// Will not be logged in a release build, and even in a debug build will
    1.16 -    /// only get persisted if an error later occurrs.
    1.17 +    /// Will not be logged in a release build at all.
    1.18 +    /// - Note: Even in a debug build,
    1.19 +    ///     does not get persisted by default (unless an error follows closely),
    1.20 +    ///     so don't expect to find this in a sysinfo log.
    1.21      public func info(function: String = #function,
    1.22                       filePath: String = #file,
    1.23                       fileLine: Int = #line,
    1.24 @@ -45,10 +48,7 @@
    1.25                  args: args)
    1.26      }
    1.27  
    1.28 -    /// Will not be logged in a release build, and even in a debug build will
    1.29 -    /// only get persisted if an error later occurrs. Use for messages
    1.30 -    /// that are needed during debugging of a feature, if it's not possible
    1.31 -    /// to do that in the debugger itself.
    1.32 +    /// Use for debug messages only, will not be persisted.
    1.33      public func debug(function: String = #function,
    1.34                        filePath: String = #file,
    1.35                        fileLine: Int = #line,
    1.36 @@ -63,6 +63,7 @@
    1.37      }
    1.38  
    1.39      /// Use this for indicating error conditions.
    1.40 +    /// - Note: Gets persisted, so a later sysinfo on the device will recover it.
    1.41      public func error(function: String = #function,
    1.42                        filePath: String = #file,
    1.43                        fileLine: Int = #line,