Add a comment explaining the use of OS_OBJECT_USE_OBJC

yinjiahjk · Nov 22, 2013 · 568a145 · 568a145
1 parent 925fc13
commit 568a145
Showing 1 changed file with 8 additions and 5 deletions.
diff --git a/src/FMDatabase.h b/src/FMDatabase.h
@@ -24,11 +24,14 @@
 
     #define FMDBRelease(__v)
 
-	#if OS_OBJECT_USE_OBJC
-		#define FMDBDispatchQueueRelease(__v)
-	#else
-		#define FMDBDispatchQueueRelease(__v) (dispatch_release(__v));
-	#endif
+// If OS_OBJECT_USE_OBJC=1, then the dispatch objects will be treated like ObjC objects
+// and will participate in ARC.
+// See the section on "Dispatch Queues and Automatic Reference Counting" in "Grand Central Dispatch (GCD) Reference" for details. 
+    #if OS_OBJECT_USE_OBJC
+        #define FMDBDispatchQueueRelease(__v)
+    #else
+        #define FMDBDispatchQueueRelease(__v) (dispatch_release(__v));
+    #endif
 #endif
 
 #if !__has_feature(objc_instancetype)