Commit 1d5bd47c authored by Mukund Sivaraman's avatar Mukund Sivaraman
Browse files

[1704] Add documentation for setInterprocessSync()

parent 328f8781
......@@ -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
......
......@@ -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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment