diff libpurple/proxy.h @ 16201:36b09c6f7957

Doxygen updates. This eliminated all the warnings from Doxygen.
author Richard Laager <rlaager@wiktel.com>
date Mon, 16 Apr 2007 05:07:21 +0000
parents 32c366eeeb99
children 44b4e8bd759b
line wrap: on
line diff
--- a/libpurple/proxy.h	Mon Apr 16 03:37:48 2007 +0000
+++ b/libpurple/proxy.h	Mon Apr 16 05:07:21 2007 +0000
@@ -250,6 +250,11 @@
 /**
  * Makes a connection through a SOCKS5 proxy.
  *
+ * @param handle     A handle that should be associated with this
+ *                   connection attempt.  The handle can be used
+ *                   to cancel the connection attempt using the
+ *                   purple_proxy_connect_cancel_with_handle()
+ *                   function.
  * @param gpi        The PurpleProxyInfo specifying the proxy settings
  * @param host       The destination host.
  * @param port       The destination port.