From: JINMEI Tatuya <jinmei@isc.org>
Date: Tue, 2 Oct 2012 14:53:56 +0000 (+0200)
Subject: [2202] Change comment style
X-Git-Tag: trac2402_base~79^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fc7462103f1fb344bf91707a1e2de99534e237b9;p=thirdparty%2Fkea.git

[2202] Change comment style

So it is consistent with the rest.
---

diff --git a/src/bin/auth/auth_srv.h b/src/bin/auth/auth_srv.h
index 8f2fcec421..ea658bca03 100644
--- a/src/bin/auth/auth_srv.h
+++ b/src/bin/auth/auth_srv.h
@@ -322,39 +322,36 @@ public:
     ///     has been set by setClientList.
     std::vector<isc::dns::RRClass> getClientListClasses() const;
 
-    /**
-     * \brief Return a mutex for the client lists.
-     *
-     * Background loading of data uses threads. Therefore we need to protect
-     * the client lists by a mutex, so they don't change (or get destroyed)
-     * during query processing. Get (and lock) this mutex whenever you do
-     * something with the lists and keep it locked until you finish. This
-     * is correct:
-     * \code
-    {
-      Mutex::Locker locker(auth->getClientListMutex());
-      boost::shared_ptr<isc::datasrc::ConfigurableClientList>
-        list(auth->getClientList(RRClass::IN()));
-      // Do some processing here
-    }
-    \endcode
-     *
-     * But this is not (it releases the mutex too soon):
-     * \code
-    boost::shared_ptr<isc::datasrc::ConfigurableClientList>
-      list;
-    {
-      Mutex::Locker locker(auth->getClientListMutex());
-      list = auth->getClientList(RRClass::IN()));
-    }
-    // Do some processing here
-     * \endcode
-     *
-     * \note This method is const even if you are allowed to modify
-     *    (lock) the mutex. It's because locking of the mutex is not really
-     *    a modification of the server object and it is needed to protect the
-     *    lists even on read-only operations.
-     */
+    /// \brief Return a mutex for the client lists.
+    ///
+    /// Background loading of data uses threads. Therefore we need to protect
+    /// the client lists by a mutex, so they don't change (or get destroyed)
+    /// during query processing. Get (and lock) this mutex whenever you do
+    /// something with the lists and keep it locked until you finish. This
+    /// is correct:
+    /// \code
+    /// {
+    ///  Mutex::Locker locker(auth->getClientListMutex());
+    ///  boost::shared_ptr<isc::datasrc::ConfigurableClientList>
+    ///    list(auth->getClientList(RRClass::IN()));
+    ///  // Do some processing here
+    /// }
+    /// \endcode
+    ///
+    /// But this is not (it releases the mutex too soon):
+    /// \code
+    /// boost::shared_ptr<isc::datasrc::ConfigurableClientList> list;
+    /// {
+    ///     Mutex::Locker locker(auth->getClientListMutex());
+    ///     list = auth->getClientList(RRClass::IN()));
+    /// }
+    /// // Do some processing here
+    /// \endcode
+    ///
+    /// \note This method is const even if you are allowed to modify
+    ///    (lock) the mutex. It's because locking of the mutex is not really
+    ///    a modification of the server object and it is needed to protect the
+    ///    lists even on read-only operations.
     isc::util::thread::Mutex& getClientListMutex() const;
 
 private: