From: Francis Dupont <fdupont@isc.org>
Date: Wed, 22 Apr 2020 13:41:01 +0000 (+0200)
Subject: [#1096] Added doxygen comments
X-Git-Tag: Kea-1.7.7~34
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7aa89cb55960d1a1b70a520d9e52daa378f4d23c;p=thirdparty%2Fkea.git

[#1096] Added doxygen comments
---

diff --git a/src/lib/process/io_service_signal.cc b/src/lib/process/io_service_signal.cc
index f3b27af7f2..76bbd54a02 100644
--- a/src/lib/process/io_service_signal.cc
+++ b/src/lib/process/io_service_signal.cc
@@ -20,19 +20,40 @@ using namespace isc::asiolink;
 namespace isc {
 namespace process {
 
-/// Implementation class of IOSignalSet.
+/// @brief Implementation class of IOSignalSet.
 class IOSignalSetImpl :
     public boost::enable_shared_from_this<IOSignalSetImpl>,
     public boost::noncopyable
 {
 public:
+    /// @brief Constructor.
+    ///
+    /// @param io_service the process IO service.
+    /// @param handler the signal handler.
     IOSignalSetImpl(IOServicePtr io_service, IOSignalHandler handler);
+
+    /// @brief Destructor.
     ~IOSignalSetImpl(){}
+
+    /// @brief Install the callback on the IO service queue.
     void install();
+
+    /// @brief Add a signal in the ASIO signal set.
+    ///
+    /// @param signum the signal number.
     void add(int signum);
+
 private:
+    /// @brief the ASIO signal set.
     boost::asio::signal_set signal_set_;
+
+    /// @brief the signal handler.
     IOSignalHandler handler_;
+
+    /// @brief the callback (called on cancel or received signal).
+    ///
+    /// The callback is installed on the IO service queue and calls
+    /// the handler if the operation was not aborted.
     void callback(const boost::system::error_code& ec, int signum);
 };