Merge pull request #423 from robertmryan/master

Update Swift comments

src/extra/Swift extensions/FMDatabaseAdditionsVariadic.swift

@@ -9,11 +9,11 @@ extension FMDatabase {
     
     /// Private generic function used for the variadic renditions of the FMDatabaseAdditions methods
     ///
-    /// :param: sql The SQL statement to be used.
-    /// :param: values The NSArray of the arguments to be bound to the ? placeholders in the SQL.
-    /// :param: completionHandler The closure to be used to call the appropriate FMDatabase method to return the desired value.
+    /// - parameter sql:                The SQL statement to be used.
+    /// - parameter values:             The NSArray of the arguments to be bound to the ? placeholders in the SQL.
+    /// - parameter completionHandler:  The closure to be used to call the appropriate FMDatabase method to return the desired value.
     ///
-    /// :returns: This returns the T value if value is found. Returns nil if column is NULL or upon error.
+    /// - returns:                      This returns the T value if value is found. Returns nil if column is NULL or upon error.
     
     private func valueForQuery<T>(sql: String, values: [AnyObject]?, completionHandler:(FMResultSet)->(T!)) -> T! {
         var result: T!
@@ -34,10 +34,10 @@ extension FMDatabase {
     /// This is a rendition of stringForQuery that handles Swift variadic parameters
     /// for the values to be bound to the ? placeholders in the SQL.
     ///
-    /// :param: sql The SQL statement to be used.
-    /// :param: values The values to be bound to the ? placeholders
+    /// - parameter sql:                The SQL statement to be used.
+    /// - parameter values:             The values to be bound to the ? placeholders
     ///
-    /// :returns: This returns string value if value is found. Returns nil if column is NULL or upon error.
+    /// - returns:                      This returns string value if value is found. Returns nil if column is NULL or upon error.
     
     func stringForQuery(sql: String, _ values: AnyObject...) -> String! {
         return valueForQuery(sql, values: values) { $0.stringForColumnIndex(0) }
@@ -46,10 +46,10 @@ extension FMDatabase {
     /// This is a rendition of intForQuery that handles Swift variadic parameters
     /// for the values to be bound to the ? placeholders in the SQL.
     ///
-    /// :param: sql The SQL statement to be used.
-    /// :param: values The values to be bound to the ? placeholders
+    /// - parameter sql:                The SQL statement to be used.
+    /// - parameter values:             The values to be bound to the ? placeholders
     ///
-    /// :returns: This returns integer value if value is found. Returns nil if column is NULL or upon error.
+    /// - returns:       This returns integer value if value is found. Returns nil if column is NULL or upon error.
     
     func intForQuery(sql: String, _ values: AnyObject...) -> Int32! {
         return valueForQuery(sql, values: values) { $0.intForColumnIndex(0) }
@@ -58,10 +58,10 @@ extension FMDatabase {
     /// This is a rendition of longForQuery that handles Swift variadic parameters
     /// for the values to be bound to the ? placeholders in the SQL.
     ///
-    /// :param: sql The SQL statement to be used.
-    /// :param: values The values to be bound to the ? placeholders
+    /// - parameter sql:                The SQL statement to be used.
+    /// - parameter values:             The values to be bound to the ? placeholders
     ///
-    /// :returns: This returns long value if value is found. Returns nil if column is NULL or upon error.
+    /// - returns:                      This returns long value if value is found. Returns nil if column is NULL or upon error.
     
     func longForQuery(sql: String, _ values: AnyObject...) -> Int! {
         return valueForQuery(sql, values: values) { $0.longForColumnIndex(0) }
@@ -70,10 +70,10 @@ extension FMDatabase {
     /// This is a rendition of boolForQuery that handles Swift variadic parameters
     /// for the values to be bound to the ? placeholders in the SQL.
     ///
-    /// :param: sql The SQL statement to be used.
-    /// :param: values The values to be bound to the ? placeholders
+    /// - parameter sql:                The SQL statement to be used.
+    /// - parameter values:             The values to be bound to the ? placeholders
     ///
-    /// :returns: This returns Bool value if value is found. Returns nil if column is NULL or upon error.
+    /// - returns:                      This returns Bool value if value is found. Returns nil if column is NULL or upon error.
     
     func boolForQuery(sql: String, _ values: AnyObject...) -> Bool! {
         return valueForQuery(sql, values: values) { $0.boolForColumnIndex(0) }
@@ -82,10 +82,10 @@ extension FMDatabase {
     /// This is a rendition of doubleForQuery that handles Swift variadic parameters
     /// for the values to be bound to the ? placeholders in the SQL.
     ///
-    /// :param: sql The SQL statement to be used.
-    /// :param: values The values to be bound to the ? placeholders
+    /// - parameter sql:                The SQL statement to be used.
+    /// - parameter values:             The values to be bound to the ? placeholders
     ///
-    /// :returns: This returns Double value if value is found. Returns nil if column is NULL or upon error.
+    /// - returns:                      This returns Double value if value is found. Returns nil if column is NULL or upon error.
     
     func doubleForQuery(sql: String, _ values: AnyObject...) -> Double! {
         return valueForQuery(sql, values: values) { $0.doubleForColumnIndex(0) }
@@ -94,10 +94,10 @@ extension FMDatabase {
     /// This is a rendition of dateForQuery that handles Swift variadic parameters
     /// for the values to be bound to the ? placeholders in the SQL.
     ///
-    /// :param: sql The SQL statement to be used.
-    /// :param: values The values to be bound to the ? placeholders
+    /// - parameter sql:                The SQL statement to be used.
+    /// - parameter values:             The values to be bound to the ? placeholders
     ///
-    /// :returns: This returns NSDate value if value is found. Returns nil if column is NULL or upon error.
+    /// - returns:                      This returns NSDate value if value is found. Returns nil if column is NULL or upon error.
     
     func dateForQuery(sql: String, _ values: AnyObject...) -> NSDate! {
         return valueForQuery(sql, values: values) { $0.dateForColumnIndex(0) }
@@ -106,10 +106,10 @@ extension FMDatabase {
     /// This is a rendition of dataForQuery that handles Swift variadic parameters
     /// for the values to be bound to the ? placeholders in the SQL.
     ///
-    /// :param: sql The SQL statement to be used.
-    /// :param: values The values to be bound to the ? placeholders
+    /// - parameter sql:                The SQL statement to be used.
+    /// - parameter values:             The values to be bound to the ? placeholders
     ///
-    /// :returns: This returns NSData value if value is found. Returns nil if column is NULL or upon error.
+    /// - returns:                      This returns NSData value if value is found. Returns nil if column is NULL or upon error.
     
     func dataForQuery(sql: String, _ values: AnyObject...) -> NSData! {
         return valueForQuery(sql, values: values) { $0.dataForColumnIndex(0) }

src/extra/Swift extensions/FMDatabaseVariadic.swift

@@ -13,10 +13,10 @@ extension FMDatabase {
     /// This is a rendition of executeQuery that handles Swift variadic parameters
     /// for the values to be bound to the ? placeholders in the SQL.
     ///
-    /// :param: sql The SQL statement to be used.
-    /// :param: values The values to be bound to the ? placeholders
+    /// - parameter sql:     The SQL statement to be used.
+    /// - parameter values:  The values to be bound to the ? placeholders
     ///
-    /// :returns: This returns FMResultSet if successful. Returns nil upon error.
+    /// - returns:           This returns FMResultSet if successful. Returns nil upon error.
     
     func executeQuery(sql:String, _ values: AnyObject...) -> FMResultSet? {
         return executeQuery(sql, withArgumentsInArray: values as [AnyObject]);
@@ -25,10 +25,10 @@ extension FMDatabase {
     /// This is a rendition of executeUpdate that handles Swift variadic parameters
     /// for the values to be bound to the ? placeholders in the SQL.
     ///
-    /// :param: sql The SQL statement to be used.
-    /// :param: values The values to be bound to the ? placeholders
+    /// - parameter sql:     The SQL statement to be used.
+    /// - parameter values:  The values to be bound to the ? placeholders
     ///
-    /// :returns: This returns true if successful. Returns false upon error.
+    /// - returns:            This returns true if successful. Returns false upon error.
     
     func executeUpdate(sql:String, _ values: AnyObject...) -> Bool {
         return executeUpdate(sql, withArgumentsInArray: values as [AnyObject]);