Document creation function

sgn-andot · Jul 14, 2016 · 1b65654 · 1b65654
1 parent 2ea0104
commit 1b65654
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/core/lib/iomgr/workqueue_posix.h b/src/core/lib/iomgr/workqueue_posix.h
@@ -50,7 +50,8 @@ struct grpc_workqueue {
   grpc_closure read_closure;
 };
 
-/** Create a work queue */
+/** Create a work queue. Returns an error if creation fails. If creation
+    succeeds, sets *workqueue to point to it. */
 grpc_error *grpc_workqueue_create(grpc_exec_ctx *exec_ctx,
                                   grpc_workqueue **workqueue);