Diff: doc/html/group__api__network__wlan.html

Revision:

17:7268f365676b

Parent:

13:2b51f5267c92

Child:

26:8067e3d463d3

--- a/doc/html/group__api__network__wlan.html	Wed Aug 13 04:41:04 2014 -0700
+++ b/doc/html/group__api__network__wlan.html	Sat Aug 23 05:39:17 2014 -0700
@@ -179,8 +179,11 @@
 </div><div class="memdoc">
 
 <p>Join a WiFi network. </p>
-<dl class="section note"><dt>Note</dt><dd>This command is returns when the join sequence has STARTED. To determine if the module has successfully join the network either specify the completeHandler or periodically call <a class="el" href="group__api__network__wlan.html#ga047ba9670f60406466391cec5bdd28e5" title="Get connection status to WiFi network. ">getNetworkStatus()</a></dd></dl>
 <p>This command has an optional background processing feature. Background processing is enabled if the completeHandler parameter is specified. If enabled, the library will poll the module every second for the join status (essentially it'll call <a class="el" href="group__api__network__wlan.html#ga047ba9670f60406466391cec5bdd28e5" title="Get connection status to WiFi network. ">getNetworkStatus()</a> every second in the background). When the module join sequence complete the callback will be executed. The background processing is disabled when <a class="el" href="group__api__network__wlan.html#ga14dc0f4fa58a7ebb25b77fae22052328" title="Leave a WiFi network. ">leave()</a> is called.</p>
+<ul>
+<li>If completeHandler parameter is NOT specified: This command will BLOCK/return WICONNECT_PROCESSING until the module has either successfully joined the network or failed.</li>
+<li>If the completeHandler parameter IS specified: This command will return and use the background processing feature described above.</li>
+</ul>
 <dl class="section note"><dt>Note</dt><dd>only the 'result' parameter of the callback handler is valid.</dd></dl>
 <p>Refer to <a class="el" href="index.html#setting_async_processing">Asynchronous Processing</a> for more info.</p>
 <dl class="params"><dt>Parameters</dt><dd>