merged AI doc, some new pages

libs/main/io_utils/pipackedtcp.h

@@ -1,9 +1,8 @@
-/*! \file pipackedtcp.h
- * \ingroup IO-Utils
- * \~\brief
- * \~english Ethernet device
- * \~russian Устройство Ethernet
- */
+//! \~\file pipackedtcp.h
+//! \~\ingroup IO-Utils
+//! \~\brief
+//! \~english Packet-oriented TCP device built on top of %PIStreamPacker
+//! \~russian Пакетно-ориентированное TCP-устройство на основе %PIStreamPacker
 /*
     PIP - Platform Independent Primitives
     Ethernet, UDP/TCP Broadcast/Multicast
@@ -34,36 +33,72 @@
 class PIEthernet;
 
 
+//! \~\ingroup IO-Utils
+//! \~\brief
+//! \~english TCP device wrapper that exposes framed packets through the %PIIODevice API.
+//! \~russian Обертка над TCP-устройством, предоставляющая кадрированные пакеты через API %PIIODevice.
+//! \details
+//! \~english
+//! The %PIPackedTCP class provides a TCP client/server device with automatic data packing/unpacking using PIStreamPacker. It
+//! supports both client and server roles with reliable byte-stream transmission over TCP connections.
+//! \~russian
+//! Класс %PIPackedTCP предоставляет устройство TCP клиент/сервер с автоматической упаковкой/распаковкой данных с использованием
+//! PIStreamPacker. Поддерживает обе роли: клиент и сервер с надежной передачей байтовых потоков по TCP соединениям.
 class PIP_IO_UTILS_EXPORT PIPackedTCP: public PIIODevice {
 	PIIODEVICE(PIPackedTCP, "ptcp");
 
 public:
-	//! \brief Role of %PIPackedTCP
+	//! \~english Operating role of %PIPackedTCP.
+	//! \~russian Роль работы %PIPackedTCP.
 	enum Role {
-		Client /** TCP client */,
-		Server /** TCP server for one client */
+		Client /** \~english TCP client side \~russian Сторона TCP-клиента */,
+		Server /** \~english TCP server for one client \~russian TCP-сервер для одного клиента */
 	};
 
-	//! Contructs %PIPackedTCP with "role" and "addr" address
+	//! \~english Constructs %PIPackedTCP with role "role" and endpoint "addr".
+	//! \~russian Создает %PIPackedTCP с ролью "role" и конечной точкой "addr".
 	explicit PIPackedTCP(Role role = Client, const PINetworkAddress & addr = {});
 
+	//! \~english Destroys the packed TCP device.
+	//! \~russian Уничтожает устройство пакетированного TCP.
 	virtual ~PIPackedTCP();
 
-	//! Set server address for Server role or connect address for Client
+	//! \~english Sets listen address for server mode or remote address for client mode.
+	//! \~russian Устанавливает адрес прослушивания для режима сервера или удаленный адрес для режима клиента.
 	void setAddress(const PINetworkAddress & addr);
 
+	//! \~english Returns true if the TCP connection is established and active
+	//! \~russian Возвращает true если TCP соединение установлено и активно
 	bool isConnected() const;
+
+	//! \~english Returns true if the device is currently attempting to establish a TCP connection
+	//! \~russian Возвращает true если устройство в данный момент пытается установить TCP соединение
 	bool isConnecting() const;
 
-	//! Returns read address in format "i.i.i.i:p"
+	//! \~english Returns configured endpoint address.
+	//! \~russian Возвращает настроенный адрес конечной точки.
 	PINetworkAddress address() const { return m_addr; }
 
-	//! Returns %PIEthernet type
+	//! \~english Returns current operating role.
+	//! \~russian Возвращает текущую рабочую роль.
 	Role role() const { return m_role; }
 
+
+	//! \events
+	//! \{
+
+	//! \fn void connected()
+	//! \~english Emitted when client connection becomes ready or a server accepts a client.
+	//! \~russian Генерируется, когда клиентское подключение готово или сервер принимает клиента.
 	EVENT0(connected);
+
+	//! \fn void disconnected()
+	//! \~english Emitted when active TCP connection is lost or closed.
+	//! \~russian Генерируется при потере или закрытии активного TCP-соединения.
 	EVENT0(disconnected);
 
+	//! \}
+
 protected:
 	void init();