[1704] Add documentation for setInterprocessSync()

diff --git a/src/lib/log/logger.h b/src/lib/log/logger.h
index d4a8b22fc5d13a81ae3e2936d6c37836c4da4831..77be7effba15076d2ef2e59dd1f8044d25ef497c 100644 (file)
--- 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 0f357b41998dd90cfd374e0eed731380b0820e1f..43d8aa25e2a33d47f6356edf6df1b0a07947fd8e 100644 (file)
--- 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