Document execute() method

Author: kean

Sources/SwiftSQL/SQLConnection.swift

@@ -30,6 +30,9 @@ public final class SQLConnection {
     /// - parameter mode: Specifies whether open the database for reading, writing
     /// or both, and whether to create it on write. `.readwrite(create: true)` by default.
     /// - parameter options: See `SQLConnectionOptions` for more information.
+    ///
+    /// - note: See [SQLite: Result and Error Codes](https://www.sqlite.org/rescode.html)
+    /// for more information.
     public init(location: Location, mode: Mode = .readwrite(create: true), options: Options = Options()) throws {
         let path: String
         var flags: Int32 = 0

Sources/SwiftSQL/SQLError.swift

@@ -6,6 +6,8 @@ import Foundation
 import SQLite3
 
 #warning("TODO: update documentation")
+/// - note: See [SQLite: Result and Error Codes](https://www.sqlite.org/rescode.html)
+/// for more information.
 public struct SQLError: Swift.Error, CustomStringConvertible {
     // MARK: Properties
 

Sources/SwiftSQL/SQLStatement.swift

@@ -64,8 +64,6 @@ public final class SQLStatement {
 
     // MARK: Execute
 
-    #warning("TODO: add example")
-
     /// Executes the statement and returns the row (`SQLRow`) if it is available.
     /// Returns nil if the statement is finished executing and no more data
     /// is available. Throws an error if an error is encountered.
@@ -79,14 +77,19 @@ public final class SQLStatement {
     ///         objects.append(user)
     ///     }
     ///
+    /// - note: See [SQLite: Result and Error Codes](https://www.sqlite.org/rescode.html)
+    /// for more information.
     public func next() throws -> SQLRow? {
         guard try isOK(sqlite3_step(ref)) == SQLITE_ROW else {
             return nil
         }
         return SQLRow(statement: self)
     }
 
-    #warning("TODO: document")
+    /// Executes the statement. Throws an error if an error is occured.
+    ///
+    /// - note: See [SQLite: Result and Error Codes](https://www.sqlite.org/rescode.html)
+    /// for more information.
     @discardableResult
     public func execute() throws -> SQLStatement {
         try isOK(sqlite3_step(ref))