From 359c6a324b2fed90902115adf697f6ee8cf8d816 Mon Sep 17 00:00:00 2001
From: Matt Goodall <matt.goodall@gmail.com>
Date: Fri, 6 Jul 2012 11:07:42 +0100
Subject: [PATCH] Document the client config.

---
 src/xmpp/client.go | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/xmpp/client.go b/src/xmpp/client.go
index 2c1a0e2..0129201 100644
--- a/src/xmpp/client.go
+++ b/src/xmpp/client.go
@@ -13,8 +13,14 @@ type client struct {
 	stream *Stream
 }
 
+// Config structure used to create a new XMPP client connection.
 type ClientConfig struct {
+	// Don't upgrade the connection to TLS, even if the server supports it. If
+	// the server *requires* TLS then this option is ignored.
 	NoTLS bool
+
+	// Skip verification of the server's certificate chain. Probably only
+	// useful during development.
 	InsecureSkipVerify bool
 }