From c087d916a1c19e9e93c5ea8b4817b1118bb244da Mon Sep 17 00:00:00 2001 From: Lynix Date: Sun, 25 Sep 2016 03:45:07 +0200 Subject: [PATCH] Network/SocketPoller: Fix missing documentation Former-commit-id: c6670596bcf9faba08d59c1e90c0596eccbabfd6 [formerly 2a358094943cd9a7971af9ae53c0d1adec34fdf8] [formerly 079909ff9f2cd7bf529eef1537b00f698a880c5f [formerly 989fe6aa5a78ae9c37e7e161ae5895b620cb8d0b]] Former-commit-id: 244c8405aeb61eefdaf47390d059d40a004e48b1 [formerly 7989e0ee5e6fee6b5ecf8e861fcd926c38ced8a2] Former-commit-id: 177e32b55a11dce2936de0e92a4d8a264a30ada4 --- src/Nazara/Network/SocketPoller.cpp | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/Nazara/Network/SocketPoller.cpp b/src/Nazara/Network/SocketPoller.cpp index 1364cb93d..72ab1a613 100644 --- a/src/Nazara/Network/SocketPoller.cpp +++ b/src/Nazara/Network/SocketPoller.cpp @@ -17,7 +17,13 @@ namespace Nz { /*! - * \brief Constructs a SocketPoller object by default + * \ingroup network + * \class Nz::SocketPoller + * \brief Network class allowing an application to wait on multiples sockets for them to become active (readable) + */ + + /*! + * \brief Constructs an empty SocketPoller object */ inline SocketPoller::SocketPoller() : m_impl(new SocketPollerImpl) @@ -26,6 +32,8 @@ namespace Nz /*! * \brief Destructs the SocketPoller + * + * \remark When the SocketPoller gets destroyed, all sockets are automatically unregistered from it. */ SocketPoller::~SocketPoller() {