Browse Source

[2850] Add API doc comments about plans to make reset(), etc. non-virtual

Mukund Sivaraman 12 years ago
parent
commit
5bfdcfaa4a
1 changed files with 6 additions and 0 deletions
  1. 6 0
      src/lib/datasrc/memory/zone_table_segment.h

+ 6 - 0
src/lib/datasrc/memory/zone_table_segment.h

@@ -106,6 +106,12 @@ private:
 /// point into a table of zones regardless of the underlying memory
 /// management implementation. Derived classes would implement the
 /// interface for specific memory-implementation behavior.
+///
+/// Note: At some point in the future, methods such as \c reset(),
+/// \c clear(), \c resetHeader(), \c getHeader(), \c isWritable(),
+/// \c isUsable() may become non-virtual methods. Such a change should
+/// not affect any code that uses this class, but please be aware of
+/// such plans.
 class ZoneTableSegment {
 protected:
     /// \brief Protected constructor