[libdispatch-changes] [184] trunk/man

[source_changes at macosforge.org]

Revision: 184
          http://trac.macosforge.org/projects/libdispatch/changeset/184
Author:   kvv at apple.com
Date:     2010-02-17 21:25:17 -0800 (Wed, 17 Feb 2010)
Log Message:
-----------
man page clarifications and typo fixes

Modified Paths:
--------------
    trunk/man/dispatch_object.3
    trunk/man/dispatch_queue_create.3
    trunk/man/dispatch_source_create.3

Modified: trunk/man/dispatch_object.3
===================================================================
--- trunk/man/dispatch_object.3	2010-01-27 17:32:37 UTC (rev 183)
+++ trunk/man/dispatch_object.3	2010-02-18 05:25:17 UTC (rev 184)
@@ -79,15 +79,17 @@
 a suspended state is undefined.
 .Sh CONTEXT POINTERS
 Dispatch queues and sources support supplemental context pointers. The value of
-the context point may be retrieved and updated with
+the context pointer may be retrieved and updated with
 .Fn dispatch_get_context
 and
 .Fn dispatch_set_context
 respectively.
 The
 .Fn dispatch_set_finalizer_f
-specifies an optional per-object finalizer function to that is invoked
-asynchronously when the last reference to the object is released. This gives the
+specifies an optional per-object finalizer function that is invoked
+asynchronously if the context pointer is not NULL when the last
+reference to the object is released.
+This gives the
 application an opportunity to free the context data associated with the object.
 .Pp
 The result of getting or setting the context of an object that is not a

Modified: trunk/man/dispatch_queue_create.3
===================================================================
--- trunk/man/dispatch_queue_create.3	2010-01-27 17:32:37 UTC (rev 183)
+++ trunk/man/dispatch_queue_create.3	2010-02-18 05:25:17 UTC (rev 184)
@@ -200,6 +200,9 @@
 .Fn dispatch_main .
 Blocks submitted to the main queue will be executed as part of the "common modes"
 of the application's main NSRunLoop or CFRunLoop.
+However, blocks submitted to the main queue in applications using
+.Fn dispatch_main
+are not guaranteed to execute on the main thread.
 .Pp
 The dispatch framework is a pure C level API. As a result, it does not catch
 exceptions generated by higher level languages such as Objective-C or C++.

Modified: trunk/man/dispatch_source_create.3
===================================================================
--- trunk/man/dispatch_source_create.3	2010-01-27 17:32:37 UTC (rev 183)
+++ trunk/man/dispatch_source_create.3	2010-02-18 05:25:17 UTC (rev 184)
@@ -175,7 +175,7 @@
 need not be reentrant safe, as it is not resubmitted to the target
 .Fa queue
 until any prior invocation for that dispatch source has completed.
-When the hander is set, the dispatch source will perform a
+When the handler is set, the dispatch source will perform a
 .Fn Block_copy
 on the
 .Fa handler
@@ -221,11 +221,11 @@
 The data will be merged with the source's pending data via an atomic add or
 logic OR (based on the source's type), and the event handler block will be
 submitted to the source's target queue. The
-.Fa mask
-and
 .Fa data
-are application defined. These sources have no
+is application defined. These sources have no
 .Fa handle
+or
+.Fa mask
 and zero should be used.
 .Pp
 .Vt DISPATCH_SOURCE_TYPE_MACH_SEND
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/libdispatch-changes/attachments/20100217/8d5e1a71/attachment.html>