# HG changeset patch
# User Richard Laager <rlaager@wiktel.com>
# Date 1123530328 0
# Node ID 03a244acce5718608d011fae583be21bc38b4c37
# Parent  5ba038e1b21f35423e3235a21776fb4b9e4188d0
[gaim-migrate @ 13342]
(14:28:27) Christopher O'Brien (siege): ArdentlyGnarly, gaim_proxy_connect's docs lie
(14:28:36) Christopher O'Brien (siege): it doesn't return a fd
(14:28:52) Christopher O'Brien (siege): it returns a status code
...
(14:37:58) rlaager: siege, ArdentlyGnarly: We should correct the docs for gaim_proxy_connect... how does this sound? "@return zero for success, any other value for failure"
...
(14:39:22) Jonathan Clark (ArdentlyGnarly): we really don't know whether or not the call was successful at the time it returns
(14:39:55) Jonathan Clark (ArdentlyGnarly): we get that information when things get back around to the callback passed to gaim_proxy_connect
(14:42:08) Jonathan Clark (ArdentlyGnarly): perhaps: @return zero indicates connection is pending, any other value for failure

committer: Tailor Script <tailor@pidgin.im>

diff -r 5ba038e1b21f -r 03a244acce57 src/proxy.h
--- a/src/proxy.h	Mon Aug 08 18:08:45 2005 +0000
+++ b/src/proxy.h	Mon Aug 08 19:45:28 2005 +0000
@@ -209,7 +209,7 @@
  * @param func    The input handler function.
  * @param data    User-defined data.
  *
- * @return The socket handle.
+ * @return Zero indicates the connection is pending. Any other value indicates failure.
  */
 int gaim_proxy_connect(GaimAccount *account, const char *host, int port,
 					   GaimInputFunction func, gpointer data);
@@ -223,7 +223,7 @@
  * @param func    The input handler function.
  * @param data    User-defined data.
  *
- * @return The socket handle.
+ * @return Zero indicates the connection is pending. Any other value indicates failure.
  */
 int gaim_proxy_connect_socks5(GaimProxyInfo *gpi, const char *host, int port,
 					   GaimInputFunction func, gpointer data);