fix info struct api docs for iface vs interface 78/3078/1
authorAndy Green <andy.green@linaro.org>
Tue, 12 Feb 2013 02:13:02 +0000 (10:13 +0800)
committerKevron Rees <kevron_m_rees@linux.intel.com>
Thu, 7 Mar 2013 21:01:34 +0000 (13:01 -0800)
Signed-off-by: Andy Green <andy.green@linaro.org>
lib/libwebsockets.h
libwebsockets-api-doc.html

index d3b5215..3a37b4f 100644 (file)
@@ -740,7 +740,7 @@ struct libwebsocket_extension {
  * @port:      Port to listen on... you can use 0 to suppress listening on
  *             any port, that's what you want if you are not running a
  *             websocket server at all but just using it as a client
- * @interface:  NULL to bind the listen socket to all interfaces, or the
+ * @iface:     NULL to bind the listen socket to all interfaces, or the
  *             interface name, eg, "eth2"
  * @protocols: Array of structures listing supported protocols and a protocol-
  *             specific callback for each one.  The list is ended with an
index a07df43..5839ac9 100644 (file)
@@ -971,6 +971,7 @@ all sessions, etc, if it wants
 <h2>struct lws_context_creation_info - </h2>
 <b>struct lws_context_creation_info</b> {<br>
 &nbsp; &nbsp; <i>int</i> <b>port</b>;<br>
+&nbsp; &nbsp; <i>const char *</i> <b>iface</b>;<br>
 &nbsp; &nbsp; <i>struct libwebsocket_protocols *</i> <b>protocols</b>;<br>
 &nbsp; &nbsp; <i>struct libwebsocket_extension *</i> <b>extensions</b>;<br>
 &nbsp; &nbsp; <i>const char *</i> <b>ssl_cert_filepath</b>;<br>
@@ -990,6 +991,9 @@ all sessions, etc, if it wants
 <dd>Port to listen on... you can use 0 to suppress listening on
 any port, that's what you want if you are not running a
 websocket server at all but just using it as a client
+<dt><b>iface</b>
+<dd>NULL to bind the listen socket to all interfaces, or the
+interface name, eg, "eth2"
 <dt><b>protocols</b>
 <dd>Array of structures listing supported protocols and a protocol-
 specific callback for each one.  The list is ended with an