From: Pekka Riikonen <priikone@silcnet.org>
Date: Sat, 21 Oct 2006 13:47:07 +0000 (+0000)
Subject: 	Comment changes.
X-Git-Tag: 1.2.beta1~673
X-Git-Url: http://git.silc.fi/gitweb/?a=commitdiff_plain;h=b2fb81c2a94f9b0d050b8a08d8938b154f63fcae;p=runtime.git

	Comment changes.
---

diff --git a/lib/silcutil/silcbuffmt.h b/lib/silcutil/silcbuffmt.h
index a3ff49dc..271137bf 100644
--- a/lib/silcutil/silcbuffmt.h
+++ b/lib/silcutil/silcbuffmt.h
@@ -21,10 +21,10 @@
  *
  * DESCRIPTION
  *
- * SILC Buffer Format API provides a few functions for formatting
- * various different data types into a buffer, and retrieving
- * various data from buffer into specific data types.  It is usefull
- * to format for example packets and later unformat them.
+ * SILC Buffer Format API provides functions for formatting different data
+ * types into a buffer and retrieving different data types from a buffer
+ * into specified data types.  It is especially useful to format packets,
+ * protocol payloads and such.
  *
  ***/
 
diff --git a/lib/silcutil/silcnet.h b/lib/silcutil/silcnet.h
index 6e7d35ed..0950d8b4 100644
--- a/lib/silcutil/silcnet.h
+++ b/lib/silcutil/silcnet.h
@@ -167,7 +167,7 @@ void silc_net_close_listener(SilcNetListener listener);
  *    asynchronous call, and this function returns before the connection is
  *    actually established.  The `callback' will be called after the
  *    connection is created to deliver the SilcStream for the created
- *    connection.
+ *    connection.  This function supports IPv6 if the platform supports it.
  *
  *    The returned SilcAsyncOperation context can be used to control the
  *    asynchronous connecting, such as to abort it.  If it is aborted
@@ -210,6 +210,8 @@ SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr,
  *    To read the packet use silc_stream_read if the remote address was
  *    provided, and silc_net_udp_receive if it was not.
  *
+ *    Supports IPv6 if the platform supports it.
+ *
  * EXAMPLE
  *
  *    SilcStream udpstream;
@@ -222,6 +224,11 @@ SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr,
  *    // Send packet to remote host
  *    silc_stream_write(udpstream, data, data_len);
  *
+ *    Create UDP listener:
+ *
+ *    udpstream = silc_net_udp_connect("0.0.0.0", 500, NULL, 0, schedule);
+ *    silc_stream_set_notifier(udpstream, schedule, receive_callback, context);
+ *
  ***/
 SilcStream silc_net_udp_connect(const char *local_ip_addr, int local_port,
 				const char *remote_ip_addr, int remote_port,
diff --git a/lib/silcutil/silcsocketstream.h b/lib/silcutil/silcsocketstream.h
index 8aa084d9..d7f5ca2b 100644
--- a/lib/silcutil/silcsocketstream.h
+++ b/lib/silcutil/silcsocketstream.h
@@ -102,7 +102,7 @@ typedef void (*SilcSocketStreamCallback)(SilcSocketStreamStatus status,
  *    the creation process.  The `callback' will be called to return the
  *    created socket stream.  To destroy the stream call silc_stream_destroy.
  *
- *    If the `lookup' is TRUE then this will performed IP and hostname lookup
+ *    If the `lookup' is TRUE then this will perform IP and hostname lookup
  *    for the socket.  If the `require_fqdn' is TRUE then the socket must
  *    have valid hostname and IP address, otherwise the stream creation will
  *    fail.  If it is FALSE then only valid IP address is required.  Note that,