From: Mukund Sivaraman <muks@isc.org>
Date: Tue, 31 Jul 2012 18:19:11 +0000 (+0530)
Subject: [2105] Document DT template parameter
X-Git-Tag: trac2351_base~146
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=9d416b80baba0fd5f44a8944fe219be49b4726ae;p=thirdparty%2Fkea.git

[2105] Document DT template parameter
---

diff --git a/src/lib/datasrc/memory/domaintree.h b/src/lib/datasrc/memory/domaintree.h
index 9f9e1659b6..51d765cc4d 100644
--- a/src/lib/datasrc/memory/domaintree.h
+++ b/src/lib/datasrc/memory/domaintree.h
@@ -785,7 +785,7 @@ private:
  *
  *  \c DomainTree splits the domain space into hierarchy red black trees; nodes
  * in one tree has the same base name. The benefit of this struct is that:
- *  - Enhances the query performace compared with one big flat red black tree.
+ *  - Enhances the query performance compared with one big flat red black tree.
  *  - Decreases the memory footprint, as it doesn't store the suffix labels
  *      multiple times.
  *
@@ -800,6 +800,13 @@ private:
  * the \c insert() method will still return \c ALREADYEXISTS regardless of
  * the search policy.
  *
+ * The template parameters taken by \c DomainTree are \c T (the type of
+ * data which is stored by the tree) and \c DT (a type whose instance is
+ * used to destroy data stored in the tree). <code>operator()</code> is
+ * called on a \c DT instance and passed a pointer to the data
+ * (<code>T*</code>) to be destroyed. This method should be written to
+ * accept \c NULL arguments.
+ *
  * \anchor diagram
  *
  * with the following names: