Merged silc_1_0_branch to trunk.

[silc.git] / lib / silcutil / silcnet.h

diff --git a/lib/silcutil/silcnet.h b/lib/silcutil/silcnet.h
index 164990985633dee78ab5686c91e27540489b58c2..062eddfd1cbcd2cf7531af684a16b1912e1df49e 100644 (file)
--- a/lib/silcutil/silcnet.h
+++ b/lib/silcutil/silcnet.h
@@ -4,12 +4,11 @@
  
   Author: Pekka Riikonen <priikone@silcnet.org>
  
-  Copyright (C) 1997 - 2001 Pekka Riikonen
+  Copyright (C) 1997 - 2005 Pekka Riikonen
  
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
-  (at your option) any later version.
+  the Free Software Foundation; version 2 of the License.
  
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -400,7 +399,8 @@ SilcUInt16 silc_net_get_local_port(int sock);
  *
  *    Return name of localhost.  This will also attempt to resolve
  *    the real hostname by the local host's IP address.  If unsuccessful
- *    the first found hostname is returned.
+ *    the first found hostname is returned.  The caller must free
+ *    returned hostname.
  *
  ***/
 char *silc_net_localhost(void);
@@ -413,13 +413,11 @@ char *silc_net_localhost(void);
  *
  * DESCRIPTION
  *
- *    Return IP of localhost.  
+ *    Return IP of localhost.  The caller must free the returned IP.
  *
  ***/
 char *silc_net_localip(void);
 
-#ifdef SILC_WIN32
-
 /****f* silcutil/SilcNetAPI/silc_net_win32_init
  *
  * SYNOPSIS
@@ -436,6 +434,10 @@ char *silc_net_localip(void);
  *    FALSE on error.  The network will not work if this function returns
  *    FALSE.
  *
+ * NOTES
+ *
+ *    This routines is available only on Win32 platform.
+ *
  ***/
 bool silc_net_win32_init(void);
 
@@ -452,9 +454,11 @@ bool silc_net_win32_init(void);
  *    is usually called when the application is exiting.  After calling
  *    this function the SILC Net API routines will not work anymore.
  *
+ * NOTES
+ *
+ *    This routines is available only on Win32 platform.
+ *
  ***/
 void silc_net_win32_uninit(void);
 
 #endif
-
-#endif