[svn] commit: r3883 - /branches/trac397focused/src/lib/datasrc/rbtree.h

[BIND 10 source code commits]

Author: jinmei
Date: Fri Dec 17 18:26:47 2010
New Revision: 3883

Log:
some final minor editorial suggestions

Modified:
    branches/trac397focused/src/lib/datasrc/rbtree.h

Modified: branches/trac397focused/src/lib/datasrc/rbtree.h
==============================================================================
--- branches/trac397focused/src/lib/datasrc/rbtree.h (original)
+++ branches/trac397focused/src/lib/datasrc/rbtree.h Fri Dec 17 18:26:47 2010
@@ -12,12 +12,16 @@
 // OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 // PERFORMANCE OF THIS SOFTWARE.
 
-/// \note Although the purpose of the RBTree is to provide a generic map with 
-/// domain name as key. Because of some unresolved design issue, the design and 
-/// interface is not fixed, RBTree isn't ready to be used as a base data sturct 
-/// by other modules.
 #ifndef _RBTREE_H
 #define _RBTREE_H 1
+
+//! \file datasrc/rbtree.h
+///
+/// \note The purpose of the RBTree is to provide a generic map with 
+/// domain names as the key that can be used by various BIND 10 modules or
+/// even by other applications.  However, because of some unresolved design
+/// issue, the design and interface are not fixed, and RBTree isn't ready to
+/// be used as a base data structure by other modules.
 
 #include <dns/name.h>
 #include <boost/utility.hpp>
@@ -81,7 +85,8 @@
 
     /// \name Test functions
     //@{
-    /// \brief return the name of current node, it's relative to its top node ///
+    /// \brief return the name of current node, it's relative to its top node
+    ///
     /// To get the absolute name of one node, the node path from the top node
     /// to current node has to be recorded
     const isc::dns::Name& getName() const { return (name_); }
@@ -103,7 +108,7 @@
     /// \name Modify functions
     //@{
     /// \breif set the data stored in the node
-    void setData(const NodeDataPtr& data) { data_ = data;}
+    void setData(const NodeDataPtr& data) { data_ = data; }
     //@}