new style of docs

Author: L0rdLizard

src/protocol/Connection.h

@@ -60,19 +60,17 @@ namespace STIP {
         /// \brief Отправка пинга(получение версии протокола)
         ///
         /// Создает сессию отправки и обработки пинга PingSession
-        /// (обавляет объект PingSession в SessionManager).
-        ///  Отправляет пинг, ждет ответ, удаляет объект PingSession из SessionManager
+        ///(добавляет объект PingSession в SessionManager).
+        /// Отправляет пинг, ждет ответ, удаляет объект PingSession из SessionManager
         ///
         /// \return версия протокола
         uint32_t pingVersion();
 
         /// \brief Отправка сообщения
         ///
         /// Создает сессию отправки сообщения SendMessageSession
-        /// Добавляет объект SendMessageSession в SessionManager
-        /// Отправляет сообщение
-        /// Ждет подтверждения
-        /// Удаляет объект SendMessageSession из SessionManager
+        ///(добавляет объект SendMessageSession в SessionManager).
+        /// Отправляет сообщение, ждет подтверждения, удаляет объект SendMessageSession из SessionManager
         ///
         /// \param data - указатель на данные
         /// \param size - размер данных в байтах
@@ -89,25 +87,23 @@ namespace STIP {
 
         /// \brief Получение пакета из очереди
         ///
-        /// Получает пакет из очереди
-        /// Если очередь пуста, ждет пока не появится пакет
+        /// Если очередь пуста, ждет пока не появится пакет.
         /// Возвращает первый пакет из очереди и удаляет его из очереди
         ///
         /// \return
         ReceiveMessageSession *receiveMessage();
 
         /// \brief Добавление пакета в очередь обработки
         ///
-        /// Добавляет пакет в очередь для данного соединения
+        /// Добавляет пакет в очередь для данного соединения.
         /// После добавления пакета в очередь, уведомляет поток обработки пакетов
         ///
         /// \param
         void addPacket(const STIP_PACKET &packet);
 
         /// \brief Получение пакета из очереди
         ///
-        /// Получает пакет из очереди
-        /// Если очередь пуста, ждет пока не появится пакет
+        /// Если очередь пуста, ждет пока не появится пакет.
         /// Возвращает пакет и результат выполнения
         ///
         /// \param result
@@ -123,25 +119,22 @@ namespace STIP {
 
         /// \brief Запуск обработки пакетов
         ///
-        /// Запуск обработки пакетов из очереди
-        /// Запускает поток processThread
-        /// Помечает isRunning как true
+        /// Запускает поток processThread,
+        /// помечает isRunning как true
         ///
         void startProcessing();
 
         /// \brief Остановка обработки пакетов
         ///
-        /// Останавливает обработку пакетов
-        /// Посылает сигнал на остановку
-        /// Помечает флаг isRunning как false
+        /// Посылает сигнал на остановку,
+        /// помечает флаг isRunning как false
         ///
         void stopProcessing();
 
         /// \brief Connection деструктор
         ///
-        /// Деструктор класса Connection
-        /// Останавливает поток обработки пакетов
-        /// Удаляет объект SessionManager
+        /// Останавливает поток обработки пакетов,
+        /// удаляет объект SessionManager
         ///
         ~Connection();
     };
@@ -157,15 +150,14 @@ namespace STIP {
     public:
         /// \brief Конструктор ConnectionManager
         ///
-        /// Конструктор класса ConnectionManager
         /// Устанавливает ссылку на сокет
         ///
         /// \param socket - ссылка на сокет
         explicit ConnectionManager(const udp::socket &socket);
 
         /// \brief Обработка пакета
         ///
-        /// Обработка пакетов из очереди
+        /// Обработка пакетов из очереди.
         /// Устанавливает соединение для пакета
         ///
         /// \param endpoint - адрес и порт подключения
@@ -205,7 +197,6 @@ namespace STIP {
 
         /// \brief Деструктор ConnectionManager
         ///
-        /// Деструктор класса ConnectionManager
         /// Удаляет все соединения
         ///
         ~ConnectionManager();