add doxygen via opencode

libs/main/cloud/picloudserver.h

@@ -1,9 +1,11 @@
-/*! \file picloudserver.h
- * \ingroup Cloud
- * \~\brief
- * \~english PICloud Server
- * \~russian Сервер PICloud
- */
+//! \file picloudserver.h
+//! \ingroup Cloud
+//! \brief
+//! \~english PICloud Server
+//! \~russian Сервер PICloud
+//! \details
+//! \~english Server implementation for accepting PICloud client connections over TCP.
+//! \~russian Реализация сервера для приема подключений клиентов PICloud по TCP.
 /*
     PIP - Platform Independent Primitives
     PICloud Server
@@ -36,25 +38,70 @@ class PIP_CLOUD_EXPORT PICloudServer
 	PIIODEVICE(PICloudServer, "");
 
 public:
-	//! PICloudServer
+	//! \brief
+	//! \~english Constructs PICloudServer
+	//! \~russian Создает PICloudServer
 	explicit PICloudServer(const PIString & path = PIString(), PIIODevice::DeviceMode mode = PIIODevice::ReadWrite);
+
+	//! \brief
+	//! \~english Destructor
+	//! \~russian Деструктор
 	virtual ~PICloudServer();
 
+	//! \brief Connected client representation
+	//! \~english Represents a client connected to the server
+	//! \~russian Представляет клиента, подключенного к серверу
 	class Client: public PIIODevice {
 		PIIODEVICE(PICloudServer::Client, "");
 		friend class PICloudServer;
 
 	public:
+		//! \brief
+		//! \~english Constructs Client
+		//! \~russian Создает Client
+		//! \param srv Parent server / Родительский сервер
+		//! \param id Client ID / ID клиента
 		Client(PICloudServer * srv = nullptr, uint id = 0);
+
+		//! \brief
+		//! \~english Destructor
+		//! \~russian Деструктор
 		virtual ~Client();
 
 	protected:
+		//! \brief
+		//! \~english Opens device
+		//! \~russian Открывает устройство
 		bool openDevice() override;
+
+		//! \brief
+		//! \~english Closes device
+		//! \~russian Закрывает устройство
 		bool closeDevice() override;
+
+		//! \brief
+		//! \~english Reads data from device
+		//! \~russian Читает данные из устройства
 		ssize_t readDevice(void * read_to, ssize_t max_size) override;
+
+		//! \brief
+		//! \~english Writes data to device
+		//! \~russian Записывает данные в устройство
 		ssize_t writeDevice(const void * data, ssize_t size) override;
+
+		//! \brief
+		//! \~english Returns device info flags
+		//! \~russian Возвращает флаги информации об устройстве
 		DeviceInfoFlags deviceInfoFlags() const override { return PIIODevice::Reliable; }
+
+		//! \brief
+		//! \~english Returns number of bytes available
+		//! \~russian Возвращает количество доступных байт
 		ssize_t bytesAvailable() const override { return buff.size(); }
+
+		//! \brief
+		//! \~english Interrupts connection
+		//! \~russian Прерывает соединение
 		void interrupt() override;
 
 	private:
@@ -67,17 +114,45 @@ public:
 		std::atomic_bool is_connected;
 	};
 
+	//! \brief
+	//! \~english Sets server name
+	//! \~russian Устанавливает имя сервера
 	void setServerName(const PIString & server_name);
 
+	//! \brief
+	//! \~english Returns list of connected clients
+	//! \~russian Возвращает список подключенных клиентов
 	PIVector<PICloudServer::Client *> clients() const;
 
+	//! \brief
+	//! \~english Raised when new client connects
+	//! \~russian Вызывается при подключении нового клиента
 	EVENT1(newConnection, PICloudServer::Client *, client);
 
 protected:
+	//! \brief
+	//! \~english Opens device
+	//! \~russian Открывает устройство
 	bool openDevice() override;
+
+	//! \brief
+	//! \~english Closes device
+	//! \~russian Закрывает устройство
 	bool closeDevice() override;
+
+	//! \brief
+	//! \~english Reads data from device
+	//! \~russian Читает данные из устройства
 	ssize_t readDevice(void * read_to, ssize_t max_size) override;
+
+	//! \brief
+	//! \~english Writes data to device
+	//! \~russian Записывает данные в устройство
 	ssize_t writeDevice(const void * data, ssize_t max_size) override;
+
+	//! \brief
+	//! \~english Interrupts connection
+	//! \~russian Прерывает соединение
 	void interrupt() override;
 
 private: