From: Mukund Sivaraman <muks@isc.org>
Date: Fri, 25 May 2012 04:33:01 +0000 (+0530)
Subject: [1704] Add documentation for setInterprocessSync()
X-Git-Tag: trac2351_base~226^2~60^2^2~44
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=1d5bd47c50ca03b87972977bb3bdd8d798148698;p=thirdparty%2Fkea.git

[1704] Add documentation for setInterprocessSync()
---

diff --git a/src/lib/log/logger.h b/src/lib/log/logger.h
index d4a8b22fc5..77be7effba 100644
--- a/src/lib/log/logger.h
+++ b/src/lib/log/logger.h
@@ -240,8 +240,15 @@ public:
 
     /// \brief Replace the interprocess synchronization object
     ///
+    /// This method is exception-free. If this method is called with
+    /// NULL as the argument, it does nothing and the old sync object is
+    /// used as before.
+    ///
     /// \param sync The logger uses this synchronization object for
-    /// synchronizing output of log messages.
+    /// synchronizing output of log messages. If NULL is passed, the old
+    /// synchronization object is used as before. When a non-NULL sync
+    /// object is passed, it should be deletable and the ownership is
+    /// transferred to the logger.
     void setInterprocessSync(isc::util::InterprocessSync* sync);
 
     /// \brief Equality
diff --git a/src/lib/log/logger_impl.h b/src/lib/log/logger_impl.h
index 0f357b4199..43d8aa25e2 100644
--- a/src/lib/log/logger_impl.h
+++ b/src/lib/log/logger_impl.h
@@ -171,8 +171,15 @@ public:
 
     /// \brief Replace the interprocess synchronization object
     ///
+    /// This method is exception-free. If this method is called with
+    /// NULL as the argument, it does nothing and the old sync object is
+    /// used as before.
+    ///
     /// \param sync The logger uses this synchronization object for
-    /// synchronizing output of log messages.
+    /// synchronizing output of log messages. If NULL is passed, the old
+    /// synchronization object is used as before. When a non-NULL sync
+    /// object is passed, it should be deletable and the ownership is
+    /// transferred to the logger implementation.
     void setInterprocessSync(isc::util::InterprocessSync* sync);
 
     /// \brief Equality