full inline sourcecode documentation

HardcoreData/Logging/HardcoreDataLogger.swift

@@ -28,6 +28,9 @@ import Foundation
 
 // MARK: - LogLevel
 
+/**
+The `LogLevel` indicates the severity of a log message.
+*/
 public enum LogLevel {
     
     case Trace
@@ -39,12 +42,42 @@ public enum LogLevel {
 
 // MARK: - HardcoreDataLogger
 
+/**
+Custom loggers should implement the `HardcoreDataLogger` protocol and pass its instance to `HardcoreData.logger`. Calls to `log(...)`, `handleError(...)`, and `assert(...)` are not tied to a specific queue/thread, so it is the implementer's job to handle thread-safety.
+*/
 public protocol HardcoreDataLogger {
     
+    /**
+    Handles log messages sent by the `HardcoreData` framework.
+    
+    :level: the severity of the log message
+    :message: the log message
+    :fileName: the source file name
+    :lineNumber: the source line number
+    :functionName: the source function name
+    */
     func log(#level: LogLevel, message: String, fileName: StaticString, lineNumber: Int, functionName: StaticString)
     
+    /**
+    Handles errors sent by the `HardcoreData` framework.
+    
+    :error: the error
+    :message: the error message
+    :fileName: the source file name
+    :lineNumber: the source line number
+    :functionName: the source function name
+    */
     func handleError(#error: NSError, message: String, fileName: StaticString, lineNumber: Int, functionName: StaticString)
     
+    /**
+    Handles assertions made throughout the `HardcoreData` framework.
+    
+    :condition: the assertion condition
+    :message: the assertion message
+    :fileName: the source file name
+    :lineNumber: the source line number
+    :functionName: the source function name
+    */
     func assert(@autoclosure condition: () -> Bool, message: String, fileName: StaticString, lineNumber: Int, functionName: StaticString)
 }