changeset 17289:bf516a0c430e

More documenting
author William Ehlhardt <williamehlhardt@gmail.com>
date Thu, 24 May 2007 06:44:57 +0000
parents a7887e79b723
children 3bccbafea8c1
files libpurple/sslconn.h
diffstat 1 files changed, 6 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/sslconn.h	Thu May 24 04:56:45 2007 +0000
+++ b/libpurple/sslconn.h	Thu May 24 06:44:57 2007 +0000
@@ -48,9 +48,14 @@
 	char *host;
 	/** Port to connect to */
 	int port;
+	/** Data to pass to PurpleSslConnection::connect_cb() */
 	void *connect_cb_data;
+	/** Callback triggered once the SSL handshake is complete */
 	PurpleSslInputFunction connect_cb;
+	/** TODO: Document me! */
 	PurpleSslErrorFunction error_cb;
+	/** Data passed to PurpleSslConnection::recv_cb() */
+	/* TODO: Is this stuff even used?? */
 	void *recv_cb_data;
 	PurpleSslInputFunction recv_cb;
 
@@ -66,9 +71,8 @@
 /**
  * SSL implementation operations structure.
  *
- * Every SSL implementation must provide all of these and register it.
+ * Every SSL implementation must provide all of these and register it via purple_ssl_set_ops()
  * These should not be called directly! Instead, use the purple_ssl_* functions.
- * @see purple_ssl_set_ops
  */
 typedef struct
 {