Merge remote-tracking branch 'origin/topic/bernhard/topk'

* origin/topic/bernhard/topk:
  3 more functions to document.

Conflicts:
	src/probabilistic/Topk.h

CHANGES

@@ -1,4 +1,8 @@
 
+2.1-1007 | 2013-08-01 15:41:54 -0700
+
+  * More function documentation. (Bernhard Amann)
+
 2.1-1004 | 2013-08-01 14:37:43 -0700
 
   * Adding a probabilistic data structure for computing "top k"

VERSION

@@ -1 +1 @@
-2.1-1004
+2.1-1007

src/probabilistic/Topk.h

@@ -129,9 +129,30 @@ protected:
 	TopkVal();
 
 private:
+	/**
+	 * Increment the counter for a specific element
+	 *
+	 * @param e element to increment counter for
+	 *
+	 * @param count increment counter by this much
+	 */
 	void IncrementCounter(Element* e, unsigned int count = 1);
-	HashKey* GetHash(Val*) const; // this probably should go somewhere else.
+
-	void Typify(BroType*);
+	/**
+	 * get the hashkey for a specific value
+	 *
+	 * @param v value to generate key for
+	 *
+	 * @returns HashKey for value
+	 */
+	HashKey* GetHash(Val* v) const; // this probably should go somewhere else.
+
+	/**
+	 * Set the type that this TopK instance tracks
+	 *
+	 * @param t type that is tracked
+	 */
+	void Typify(BroType* t);
 
 	BroType* type;
 	CompositeHash* hash;