From 6f3c5b806eb59e2610f8bac9ad3fff24994609c9 Mon Sep 17 00:00:00 2001
From: Tycho Bickerstaff <work.tycho@gmail.com>
Date: Fri, 3 Jan 2014 11:22:01 +0000
Subject: [PATCH] implement xsofts recommendations

---
 src/OSSupport/Queue.h | 24 +++++++++++++++---------
 1 file changed, 15 insertions(+), 9 deletions(-)

diff --git a/src/OSSupport/Queue.h b/src/OSSupport/Queue.h
index 1f0c19f40..65f9bd258 100644
--- a/src/OSSupport/Queue.h
+++ b/src/OSSupport/Queue.h
@@ -5,15 +5,18 @@
 
 #pragma once
 
-#include <list>
-
 /*
+Items can be added multiple times to a queue, there are two functions for
+adding, EnqueueItem() and EnqueueItemIfNotPresent(). The first one always
+enqueues the specified item, the second one checks if the item is already
+present and only queues it if it isn't.
+
 Usage:
-To use the callback functions Delete and Combine create a class with the two
-methods and pass it as a second template parameter to cQueue. The class does
-not need to inherit cQueueFuncs but you do so to document the classes purpose.
-The second template parmeter is optional if not overriding the callback
-functions
+To create a queue of type T, instantiate a cQueue<T> object. You can also
+modify the behavior of the queue when deleting items and when adding items
+that are already in the queue by providing a second parameter, a class that
+implements the functions Delete() and Combine(). An example is given in
+cQueueFuncs and is used as the default behavior.
 */
 
 // this empty struct allows for the callback functions to be inlined
@@ -25,7 +28,7 @@ struct cQueueFuncs
 		static void Delete(T) {};
 		// Called when an Item is inserted with EnqueueItemIfNotPresent and
 		// there is another equal value already inserted
-		static void Combine(T& a_existing, const T a_new) {};
+		static void Combine(T& a_existing, const T& a_new) {};
 };
 
 template<class ItemType, class Funcs = cQueueFuncs<ItemType> >
@@ -73,7 +76,10 @@ public:
 	bool     TryDequeueItem(ItemType& item)
 	{
 		cCSLock Lock(m_CS);
-		if (m_contents.size() == 0) return false;
+		if (m_contents.size() == 0) 
+		{
+			return false; 
+		}
 		item = m_contents.front();
 		m_contents.pop_front();
 		m_evtRemoved.Set();