Bit'o documentation

robbiehanson · robbiehanson · commit c437076e77d1 · 2012-10-26T15:14:39.000-07:00
diff --git a/GCD/GCDAsyncSocket.m b/GCD/GCDAsyncSocket.m
@@ -7042,11 +7042,17 @@ - (BOOL)openStreams
 #pragma mark Advanced
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
+/**
+ * See header file for big discussion of this method.
+**/
 - (void)performBlock:(dispatch_block_t)block
 {
 	dispatch_sync(socketQueue, block);
 }
 
+/**
+ * Questions? Have you read the header file?
+**/
 - (int)socketFD
 {
 	if (dispatch_get_current_queue() != socketQueue)
@@ -7061,6 +7067,9 @@ - (int)socketFD
 		return socket6FD;
 }
 
+/**
+ * Questions? Have you read the header file?
+**/
 - (int)socket4FD
 {
 	if (dispatch_get_current_queue() != socketQueue)
@@ -7072,6 +7081,9 @@ - (int)socket4FD
 	return socket4FD;
 }
 
+/**
+ * Questions? Have you read the header file?
+**/
 - (int)socket6FD
 {
 	if (dispatch_get_current_queue() != socketQueue)
@@ -7085,6 +7097,9 @@ - (int)socket6FD
 
 #if TARGET_OS_IPHONE
 
+/**
+ * Questions? Have you read the header file?
+**/
 - (CFReadStreamRef)readStream
 {
 	if (dispatch_get_current_queue() != socketQueue)
@@ -7099,6 +7114,9 @@ - (CFReadStreamRef)readStream
 	return readStream;
 }
 
+/**
+ * Questions? Have you read the header file?
+**/
 - (CFWriteStreamRef)writeStream
 {
 	if (dispatch_get_current_queue() != socketQueue)
@@ -7144,6 +7162,9 @@ - (BOOL)enableBackgroundingOnSocketWithCaveat:(BOOL)caveat
 	return YES;
 }
 
+/**
+ * Questions? Have you read the header file?
+**/
 - (BOOL)enableBackgroundingOnSocket
 {
 	LogTrace();

Original file line number	Diff line number	Diff line change
`@@ -7042,11 +7042,17 @@ - (BOOL)openStreams`
`7042`	`7042`	`#pragma mark Advanced`
`7043`	`7043`	`////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////`
`7044`	`7044`
	`7045`	`+/**`
	`7046`	`+ * See header file for big discussion of this method.`
	`7047`	`+**/`
`7045`	`7048`	`- (void)performBlock:(dispatch_block_t)block`
`7046`	`7049`	`{`
`7047`	`7050`	`dispatch_sync(socketQueue, block);`
`7048`	`7051`	`}`
`7049`	`7052`
	`7053`	`+/**`
	`7054`	`+ * Questions? Have you read the header file?`
	`7055`	`+**/`
`7050`	`7056`	`- (int)socketFD`
`7051`	`7057`	`{`
`7052`	`7058`	`if (dispatch_get_current_queue() != socketQueue)`
`@@ -7061,6 +7067,9 @@ - (int)socketFD`
`7061`	`7067`	`return socket6FD;`
`7062`	`7068`	`}`
`7063`	`7069`
	`7070`	`+/**`
	`7071`	`+ * Questions? Have you read the header file?`
	`7072`	`+**/`
`7064`	`7073`	`- (int)socket4FD`
`7065`	`7074`	`{`
`7066`	`7075`	`if (dispatch_get_current_queue() != socketQueue)`
`@@ -7072,6 +7081,9 @@ - (int)socket4FD`
`7072`	`7081`	`return socket4FD;`
`7073`	`7082`	`}`
`7074`	`7083`
	`7084`	`+/**`
	`7085`	`+ * Questions? Have you read the header file?`
	`7086`	`+**/`
`7075`	`7087`	`- (int)socket6FD`
`7076`	`7088`	`{`
`7077`	`7089`	`if (dispatch_get_current_queue() != socketQueue)`
`@@ -7085,6 +7097,9 @@ - (int)socket6FD`
`7085`	`7097`
`7086`	`7098`	`#if TARGET_OS_IPHONE`
`7087`	`7099`
	`7100`	`+/**`
	`7101`	`+ * Questions? Have you read the header file?`
	`7102`	`+**/`
`7088`	`7103`	`- (CFReadStreamRef)readStream`
`7089`	`7104`	`{`
`7090`	`7105`	`if (dispatch_get_current_queue() != socketQueue)`
`@@ -7099,6 +7114,9 @@ - (CFReadStreamRef)readStream`
`7099`	`7114`	`return readStream;`
`7100`	`7115`	`}`
`7101`	`7116`
	`7117`	`+/**`
	`7118`	`+ * Questions? Have you read the header file?`
	`7119`	`+**/`
`7102`	`7120`	`- (CFWriteStreamRef)writeStream`
`7103`	`7121`	`{`
`7104`	`7122`	`if (dispatch_get_current_queue() != socketQueue)`
`@@ -7144,6 +7162,9 @@ - (BOOL)enableBackgroundingOnSocketWithCaveat:(BOOL)caveat`
`7144`	`7162`	`return YES;`
`7145`	`7163`	`}`
`7146`	`7164`
	`7165`	`+/**`
	`7166`	`+ * Questions? Have you read the header file?`
	`7167`	`+**/`
`7147`	`7168`	`- (BOOL)enableBackgroundingOnSocket`
`7148`	`7169`	`{`
`7149`	`7170`	`LogTrace();`