Improve documentation

Author: radex

Sources/SwiftyTimer.swift

@@ -25,6 +25,36 @@
 import Foundation
 
 extension NSTimer {
+    
+// MARK: Schedule timers
+    
+    /// Create and schedule a timer that will call `block` once after the specified time.
+    
+    public class func after(interval: NSTimeInterval, _ block: () -> Void) -> NSTimer {
+        let timer = NSTimer.new(after: interval, block)
+        timer.start()
+        return timer
+    }
+    
+    /// Create and schedule a timer that will call `block` repeatedly in specified time intervals.
+    
+    public class func every(interval: NSTimeInterval, _ block: () -> Void) -> NSTimer {
+        let timer = NSTimer.new(every: interval, block)
+        timer.start()
+        return timer
+    }
+    
+    /// Create and schedule a timer that will call `block` repeatedly in specified time intervals.
+    /// (This variant also passes the timer instance to the block)
+    
+    @nonobjc public class func every(interval: NSTimeInterval, _ block: NSTimer -> Void) -> NSTimer {
+        let timer = NSTimer.new(every: interval, block)
+        timer.start()
+        return timer
+    }
+    
+// MARK: Create timers without scheduling
+    
     /// Create a timer that will call `block` once after the specified time.
     ///
     /// - Note: The timer won't fire until it's scheduled on the run loop.
@@ -40,7 +70,7 @@ extension NSTimer {
     /// Create a timer that will call `block` repeatedly in specified time intervals.
     ///
     /// - Note: The timer won't fire until it's scheduled on the run loop.
-    ///         Use `NSTimer.after` to create and schedule a timer in one step.
+    ///         Use `NSTimer.every` to create and schedule a timer in one step.
     /// - Note: The `new` class function is a workaround for a crashing bug when using convenience initializers (rdar://18720947)
 
     public class func new(every interval: NSTimeInterval, _ block: () -> Void) -> NSTimer {
@@ -53,7 +83,7 @@ extension NSTimer {
     /// (This variant also passes the timer instance to the block)
     ///
     /// - Note: The timer won't fire until it's scheduled on the run loop.
-    ///         Use `NSTimer.after` to create and schedule a timer in one step.
+    ///         Use `NSTimer.every` to create and schedule a timer in one step.
     /// - Note: The `new` class function is a workaround for a crashing bug when using convenience initializers (rdar://18720947)
 
     @nonobjc public class func new(every interval: NSTimeInterval, _ block: NSTimer -> Void) -> NSTimer {
@@ -63,31 +93,8 @@ extension NSTimer {
         }
         return timer
     }
-
-    /// Create and schedule a timer that will call `block` once after the specified time.
-    
-    public class func after(interval: NSTimeInterval, _ block: () -> Void) -> NSTimer {
-        let timer = NSTimer.new(after: interval, block)
-        timer.start()
-        return timer
-    }
 
-    /// Create and schedule a timer that will call `block` repeatedly in specified time intervals.
-    
-    public class func every(interval: NSTimeInterval, _ block: () -> Void) -> NSTimer {
-        let timer = NSTimer.new(every: interval, block)
-        timer.start()
-        return timer
-    }
-    
-    /// Create and schedule a timer that will call `block` repeatedly in specified time intervals.
-    /// (This variant also passes the timer instance to the block)
-    
-    @nonobjc public class func every(interval: NSTimeInterval, _ block: NSTimer -> Void) -> NSTimer {
-        let timer = NSTimer.new(every: interval, block)
-        timer.start()
-        return timer
-    }
+// MARK: Manual scheduling
 
     /// Schedule this timer on the run loop
     ///