add doxygen via opencode

libs/main/cloud/picloudclient.h

@@ -1,9 +1,11 @@
-/*! \file picloudclient.h
- * \ingroup Cloud
- * \~\brief
- * \~english PICloud Client
- * \~russian Клиент PICloud
- */
+//! \file picloudclient.h
+//! \ingroup Cloud
+//! \brief
+//! \~english PICloud Client
+//! \~russian Клиент PICloud
+//! \details
+//! \~english Client implementation for connecting to PICloud servers over TCP.
+//! \~russian Реализация клиента для подключения к серверам PICloud по TCP.
 /*
     PIP - Platform Independent Primitives
     PICloud Client
@@ -30,7 +32,9 @@
 #include "piconditionvar.h"
 
 
-//! \brief PICloudClient
+//! \brief PICloud client implementation
+//! \~english PICloud client for connecting to servers
+//! \~russian Клиент PICloud для подключения к серверам
 
 class PIP_CLOUD_EXPORT PICloudClient
 	: public PIIODevice
@@ -38,23 +42,75 @@ class PIP_CLOUD_EXPORT PICloudClient
 	PIIODEVICE(PICloudClient, "");
 
 public:
+	//! \brief
+	//! \~english Constructs PICloudClient
+	//! \~russian Создает PICloudClient
 	explicit PICloudClient(const PIString & path = PIString(), PIIODevice::DeviceMode mode = PIIODevice::ReadWrite);
+
+	//! \brief
+	//! \~english Destructor
+	//! \~russian Деструктор
 	virtual ~PICloudClient();
 
+	//! \brief
+	//! \~english Sets server name
+	//! \~russian Устанавливает имя сервера
 	void setServerName(const PIString & server_name);
+
+	//! \brief
+	//! \~english Sets keep connection mode
+	//! \~russian Устанавливает режим поддержания соединения
 	void setKeepConnection(bool on);
+
+	//! \brief
+	//! \~english Checks if connected to server
+	//! \~russian Проверяет подключение к серверу
 	bool isConnected() const { return is_connected; }
+
+	//! \brief
+	//! \~english Returns number of bytes available
+	//! \~russian Возвращает количество доступных байт
 	ssize_t bytesAvailable() const override { return buff.size(); }
+
+	//! \brief
+	//! \~english Interrupts connection
+	//! \~russian Прерывает соединение
 	void interrupt() override;
 
+	//! \brief
+	//! \~english Raised when connected to server
+	//! \~russian Вызывается при подключении к серверу
 	EVENT(connected);
+
+	//! \brief
+	//! \~english Raised when disconnected from server
+	//! \~russian Вызывается при отключении от сервера
 	EVENT(disconnected);
 
 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; }
 
 private: