more ai generated doc with human review

libs/main/io_utils/pibroadcast.h

@@ -31,13 +31,16 @@
 #include "pip_io_utils_export.h"
 
 
+//! \~english Broadcast for all interfaces, including loopback
+//! \~russian Широкое вещание на все интерфейсы, включая loopback
 class PIP_IO_UTILS_EXPORT PIBroadcast
 	: public PIThread
 	, public PIEthUtilBase {
 	PIOBJECT_SUBCLASS(PIBroadcast, PIThread);
 
 public:
-	//! %PIBroadcast channels, can be used independently
+	//! \~english %PIBroadcast channels, can be used independently
+	//! \~russian Каналы %PIBroadcast, могут использоваться независимо
 	enum Channel {
 		Multicast /** Use multicast addresses */ = 0x01,
 		Broadcast /** Use broadcast addresses */ = 0x02,
@@ -45,75 +48,97 @@ public:
 		All /** Use all channels */              = 0xFFFF,
 	};
 
+	//! \~english Channels flags type
+	//! \~russian Тип флагов каналов
 	typedef PIFlags<Channel> Channels;
 
-	/** Contructs %PIBroadcast, if \"send_only\" not set
-	 * all PIEthernets will be binded to receive data
-	 * */
+	//! \~english Constructs %PIBroadcast. If "send_only" not set, all PIEthernets will be binded to receive data
+	//! \~russian Создает %PIBroadcast. Если "send_only" не установлен, все PIEthernets будут привязаны для приема данных
 	PIBroadcast(bool send_only = false);
 
+	//! \~english Destructor
+	//! \~russian Деструктор
 	~PIBroadcast();
 
-	//! Set channels to \"ch\" and queue to reinit
+	//! \~english Set channels to "ch" and queue to reinit
+	//! \~russian Установить каналы в "ch" и очередь на реинициализацию
 	void setChannels(Channels ch);
 
-	//! Returns channels
+	//! \~english Returns channels
+	//! \~russian Возвращает каналы
 	Channels channels() const { return _channels; }
 
-	//! Returns if is send_only
+	//! \~english Returns if is send_only
+	//! \~russian Возвращает, является ли отправка только
 	bool isSendOnly() const { return _send_only; }
 
 
-	//! Set multicast IP to \"mg\" and queue to reinit
+	//! \~english Set multicast IP to "mg" and queue to reinit
+	//! \~russian Установить multicast IP в "mg" и очередь на реинициализацию
 	void setMulticastGroup(const PIString & mg);
 
-	//! Returns multicast IP
+	//! \~english Returns multicast IP
+	//! \~russian Возвращает multicast IP
 	PIString multicastGroup() const { return mcast_address.ipString(); }
 
-	//! Set multicast port to \"port\" and queue to reinit
+	//! \~english Set multicast port to "port" and queue to reinit
+	//! \~russian Установить multicast порт в "port" и очередь на реинициализацию
 	void setMulticastPort(ushort port);
 
-	//! Returns multicast port
+	//! \~english Returns multicast port
+	//! \~russian Возвращает multicast порт
 	ushort multicastPort() const { return mcast_address.port(); }
 
-	//! Set multicast address to \"addr\" and queue to reinit
+	//! \~english Set multicast address to "addr" and queue to reinit
+	//! \~russian Установить multicast адрес в "addr" и очередь на реинициализацию
 	void setMulticastAddress(const PINetworkAddress & addr);
 
-	//! Returns multicast address
+	//! \~english Returns multicast address
+	//! \~russian Возвращает multicast адрес
 	PINetworkAddress multicastAddress() const { return mcast_address; }
 
 
-	//! Set broadcast port to \"port\" and queue to reinit
+	//! \~english Set broadcast port to "port" and queue to reinit
+	//! \~russian Установить broadcast порт в "port" и очередь на реинициализацию
 	void setBroadcastPort(ushort port);
 
-	//! Returns broadcast port
+	//! \~english Returns broadcast port
+	//! \~russian Возвращает broadcast порт
 	ushort broadcastPort() { return bcast_port; }
 
 
-	//! Set loopback start port to \"port\" and queue to reinit
+	//! \~english Set loopback start port to "port" and queue to reinit
+	//! \~russian Установить начальный loopback порт в "port" и очередь на реинициализацию
 	void setLoopbackPort(ushort port);
 
-	//! Returns loopback start port
+	//! \~english Returns loopback start port
+	//! \~russian Возвращает начальный loopback порт
 	ushort loopbackPort() { return lo_port; }
 
-	//! Set loopback ports count to \"count\" and queue to reinit
+	//! \~english Set loopback ports count to "count" and queue to reinit
+	//! \~russian Установить количество loopback портов в "count" и очередь на реинициализацию
 	void setLoopbackPortsCount(int count);
 
-	//! Returns loopback ports count
+	//! \~english Returns loopback ports count
+	//! \~russian Возвращает количество loopback портов
 	int loopbackPortsCount() const { return lo_pcnt; }
 
 
-	//! If not send_only starts all threaded reads
+	//! \~english If not send_only starts all threaded reads
+	//! \~russian Если не send_only запускает все потоковые чтения
 	void startRead();
 
-	//! Stop all threaded reads
+	//! \~english Stop all threaded reads
+	//! \~russian Остановить все потоковые чтения
 	void stopRead();
 
-	//! Reinit all PIEthernets with current \a PIEthernet::allAddresses()
+	//! \~english Reinit all PIEthernets with current \a PIEthernet::allAddresses()
+	//! \~russian Реинициализировать все PIEthernets с текущими \a PIEthernet::allAddresses()
 	void reinit();
 
 
-	//! Send packet
+	//! \~english Send packet
+	//! \~russian Отправить пакет
 	void send(const PIByteArray & data);
 
 	EVENT1(receiveEvent, PIByteArray, data);