Browse Source

added notes about protected destructors in base classes.

git-svn-id: svn://bind10.isc.org/svn/bind10/branches/trac221b@2554 e5f2f494-b856-4b98-b285-d166d9295462
JINMEI Tatuya 15 years ago
parent
commit
252f19a143
2 changed files with 11 additions and 0 deletions
  1. 6 0
      src/lib/cc/session.h
  2. 5 0
      src/lib/xfr/xfrout_client.h

+ 6 - 0
src/lib/cc/session.h

@@ -60,8 +60,14 @@ namespace isc {
             AbstractSession(const AbstractSession& source);
             AbstractSession(const AbstractSession& source);
             AbstractSession& operator=(const AbstractSession& source);
             AbstractSession& operator=(const AbstractSession& source);
         protected:
         protected:
+            /// \brief The default constructor.
+            ///
+            /// This is intentionally defined as \c protected as this base
+            /// class should never be instantiated (except as part of a
+            /// derived class).
             AbstractSession() {}
             AbstractSession() {}
         public:
         public:
+            /// \brief The destructor.
             virtual ~AbstractSession() {}
             virtual ~AbstractSession() {}
             //@}
             //@}
             virtual void establish(const char* socket_file) = 0;
             virtual void establish(const char* socket_file) = 0;

+ 5 - 0
src/lib/xfr/xfrout_client.h

@@ -51,8 +51,13 @@ private:
     AbstractXfroutClient(const AbstractXfroutClient& source);
     AbstractXfroutClient(const AbstractXfroutClient& source);
     AbstractXfroutClient& operator=(const AbstractXfroutClient& source);
     AbstractXfroutClient& operator=(const AbstractXfroutClient& source);
 protected:
 protected:
+    /// \brief The default constructor.
+    ///
+    /// This is intentionally defined as \c protected as this base class should
+    /// never be instantiated (except as part of a derived class).
     AbstractXfroutClient() {}
     AbstractXfroutClient() {}
 public:
 public:
+    /// \brief The destructor.
     virtual ~AbstractXfroutClient() {}
     virtual ~AbstractXfroutClient() {}
     //@}
     //@}
     virtual void connect() = 0;
     virtual void connect() = 0;