starred/CoreStore
1
0
Fork 0
mirror of https://github.com/JohnEstropia/CoreStore.git synced 2026-03-11 21:11:58 +01:00
Code Issues 95 Packages Projects Releases 10 Wiki Activity

comment documentations

Browse Source
This commit is contained in:
John Rommel Estropia
2016-04-03 19:47:25 +09:00
parent ab3095f078
commit dccc958ef1
54 changed files with 333 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
Sources/Logging/CoreStoreLogger.swift
View File

@@ -50,33 +50,33 @@ public protocol CoreStoreLogger {
/**
Handles log messages sent by the `CoreStore` 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
- parameter level: the severity of the log message
- parameter message: the log message
- parameter fileName: the source file name
- parameter lineNumber: the source line number
- parameter functionName: the source function name
*/
func log(level level: LogLevel, message: String, fileName: StaticString, lineNumber: Int, functionName: StaticString)
/**
Handles errors sent by the `CoreStore` framework.
:error: the error
:message: the error message
:fileName: the source file name
:lineNumber: the source line number
:functionName: the source function name
- parameter error: the error
- parameter message: the error message
- parameter fileName: the source file name
- parameter lineNumber: the source line number
- parameter functionName: the source function name
*/
func log(error error: CoreStoreError, message: String, fileName: StaticString, lineNumber: Int, functionName: StaticString)
/**
Handles assertions made throughout the `CoreStore` framework.
:condition: the assertion condition
:message: the assertion message
:fileName: the source file name
:lineNumber: the source line number
:functionName: the source function name
- parameter condition: the assertion condition
- parameter message: the assertion message
- parameter fileName: the source file name
- parameter lineNumber: the source line number
- parameter functionName: the source function name
*/
func assert(@autoclosure condition: () -> Bool, @autoclosure message: () -> String, fileName: StaticString, lineNumber: Int, functionName: StaticString)

29
Sources/Logging/DefaultLogger.swift
View File

@@ -41,7 +41,16 @@ public final class DefaultLogger: CoreStoreLogger {
Creates a `DefaultLogger`.
*/
public init() { }
/**
Handles log messages sent by the `CoreStore` framework.
- parameter level: the severity of the log message
- parameter message: the log message
- parameter fileName: the source file name
- parameter lineNumber: the source line number
- parameter functionName: the source function name
*/
public func log(level level: LogLevel, message: String, fileName: StaticString, lineNumber: Int, functionName: StaticString) {
#if DEBUG
@@ -69,6 +78,15 @@ public final class DefaultLogger: CoreStoreLogger {
#endif
}
/**
Handles errors sent by the `CoreStore` framework.
- parameter error: the error
- parameter message: the error message
- parameter fileName: the source file name
- parameter lineNumber: the source line number
- parameter functionName: the source function name
*/
public func log(error error: CoreStoreError, message: String, fileName: StaticString, lineNumber: Int, functionName: StaticString) {
#if DEBUG
@@ -76,6 +94,15 @@ public final class DefaultLogger: CoreStoreLogger {
#endif
}
/**
Handles assertions made throughout the `CoreStore` framework.
- parameter :condition: the assertion condition
- parameter message: the assertion message
- parameter fileName: the source file name
- parameter lineNumber: the source line number
- parameter functionName: the source function name
*/
public func assert(@autoclosure condition: () -> Bool, @autoclosure message: () -> String, fileName: StaticString, lineNumber: Int, functionName: StaticString) {
#if DEBUG