From b0c58bab78178e088f619fa58e4aad4fde670e58 Mon Sep 17 00:00:00 2001
From: Christoph Borchert <christoph.borchert@tu-dortmund.de>
Date: Tue, 16 Dec 2014 12:02:57 +0100
Subject: [PATCH] util: SumTree::add() documentation

This function copies the reference argument 'element' internally.

Change-Id: I33d94f224bc2b1b89057b90258d500eaa364ab85
---
 src/core/util/SumTree.hpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/core/util/SumTree.hpp b/src/core/util/SumTree.hpp
index 998e3e05..337e7db8 100644
--- a/src/core/util/SumTree.hpp
+++ b/src/core/util/SumTree.hpp
@@ -51,7 +51,7 @@ class SumTree {
 public:
 	SumTree() : m_root(new Bucket), m_depth(0) {}
 	~SumTree() { delete m_root; }
-	//! Adds a new element to the tree.
+	//! Adds a copy of a new element to the tree.  The copy is created internally.
 	void add(const T& element);
 	//! Retrieves (and removes) element at random number position.
 	T get(typename T::size_type pos) { return get(pos, m_root, 0); }