Browse Source

[1608] added more note about AdditionalNodeInfo visibility.

JINMEI Tatuya 13 years ago
parent
commit
a8c1ced88d
1 changed files with 6 additions and 2 deletions
  1. 6 2
      src/lib/datasrc/rbnode_rrset.h

+ 6 - 2
src/lib/datasrc/rbnode_rrset.h

@@ -37,8 +37,12 @@ namespace internal {
 struct RBNodeRRsetImpl;
 
 // Forward declaration of an opaque data type defined and used within the
-// implementation.  This is public only because it needs to be used outside
-// of the \c RBNodeRRset class, but conceptually this is a private type.
+// implementation.  This is public only because it needs to be used within
+// the in-memory data source implementation, but conceptually this is a
+// private type for the in-memory data source implementation.
+// Note that the definition of the structure is still hidden within the
+// implementation, so, basically, a normal application should never be able
+// to use it directly even if it peeks into the "internal" namespace.
 struct AdditionalNodeInfo;
 
 /// \brief Special RRset for optimizing memory datasource requirement