improved comment on scanner_node_connect_tcp

ajdavis · ajdavis · commit b145f9f542d8 · 2015-09-24T09:41:35.000-04:00
diff --git a/src/mongoc/mongoc-topology-scanner.c b/src/mongoc/mongoc-topology-scanner.c
@@ -285,6 +285,9 @@ mongoc_topology_scanner_ismaster_handler (mongoc_async_cmd_result_t async_status
  *      Create a socket stream for this node, begin a non-blocking
  *      connect and return.
  *
+ * Returns:
+ *      A stream. On failure, return NULL and fill out the error.
+ *
  *--------------------------------------------------------------------------
  */
 

Original file line number	Diff line number	Diff line change
`@@ -285,6 +285,9 @@ mongoc_topology_scanner_ismaster_handler (mongoc_async_cmd_result_t async_status`
`285`	`285`	`* Create a socket stream for this node, begin a non-blocking`
`286`	`286`	`* connect and return.`
`287`	`287`	`*`
	`288`	`+ * Returns:`
	`289`	`+ * A stream. On failure, return NULL and fill out the error.`
	`290`	`+ *`
`288`	`291`	`*--------------------------------------------------------------------------`
`289`	`292`	`*/`
`290`	`293`