From 360d7d6e0b184fea1d22ba0cc755db6f2e57e889 Mon Sep 17 00:00:00 2001
From: Kevin Smith <git@kismith.co.uk>
Date: Thu, 23 Jul 2015 17:33:14 +0100
Subject: Add note on use of Connector::stop()

As the correct API usage might not be obvious

Change-Id: I1d4887d7101ce59eb8f3a3dc13d94befe4a58948

diff --git a/Swiften/Network/Connector.h b/Swiften/Network/Connector.h
index a8b0a2b..f34eaa6 100644
--- a/Swiften/Network/Connector.h
+++ b/Swiften/Network/Connector.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010 Isode Limited.
+ * Copyright (c) 2010-2015 Isode Limited.
  * All rights reserved.
  * See the COPYING file for more information.
  */
@@ -33,6 +33,11 @@ namespace Swift {
 			}
 
 			void setTimeoutMilliseconds(int milliseconds);
+			/**
+			 * Start the connection attempt.
+			 * Note that after calling this method, the caller is responsible for calling #stop()
+			 * if it wants to cancel it. Not doing so can leak references.
+			 */
 			void start();
 			void stop();
 
-- 
cgit v0.10.2-6-g49f6