From: Guus Sliepen <guus@sliepen.org>
Date: Mon, 21 Apr 2014 18:28:54 +0000 (+0200)
Subject: Clarify the behaviour of meshlink_open(), _start(), _stop() and _close().
X-Git-Url: https://git.meshlink.io/?a=commitdiff_plain;h=69d248741bba651688b1dd080e93f887b0746f41;p=meshlink

Clarify the behaviour of meshlink_open(), _start(), _stop() and _close().
---

diff --git a/src/meshlink.h b/src/meshlink.h
index ffd05af2..36548bf7 100644
--- a/src/meshlink.h
+++ b/src/meshlink.h
@@ -66,6 +66,9 @@ extern const char *meshlink_strerror(meshlink_errno_t errno);
  *  but it is not a problem if it is run more than once, as long as
  *  the arguments given are the same.
  *
+ *  This function does not start any network I/O yet. The application should
+ *  first set callbacks, and then call meshlink_start().
+ *
  *  @param confbase The directory in which MeshLink will store its configuration files.
  *  @param name     The name which this instance of the application will use in the mesh.
  *
@@ -74,8 +77,8 @@ extern const char *meshlink_strerror(meshlink_errno_t errno);
 extern meshlink_handle_t *meshlink_open(const char *confbase, const char *name);
 
 /// Start MeshLink.
-/** This function causes MeshLink to create a new thread, which will
- *  handle all network I/O.
+/** This function causes MeshLink to open network sockets, make outgoing connections, and
+ *  create a new thread, which will handle all network I/O.
  *
  *  @param confbase The directory in which MeshLink will store its configuration files.
  *
@@ -85,7 +88,7 @@ extern bool meshlink_start(meshlink_handle_t *mesh);
 
 /// Stop MeshLink.
 /** This function causes MeshLink to disconnect from all other nodes,
- *  and shuts down its own thread.
+ *  close all sockets, and shut down its own thread.
  *
  * @param handle    A handle which represents an instance of MeshLink.
  */