merged AI doc, some new pages

libs/main/cloud/picloudclient.h

@@ -1,9 +1,8 @@
-/*! \file picloudclient.h
- * \ingroup Cloud
- * \~\brief
- * \~english PICloud Client
- * \~russian Клиент PICloud
- */
+//! \~\file picloudclient.h
+//! \~\ingroup Cloud
+//! \~\brief
+//! \~english Client-side PICloud device for one named server
+//! \~russian Клиентское устройство PICloud для одного именованного сервера
 /*
     PIP - Platform Independent Primitives
     PICloud Client
@@ -29,27 +28,61 @@
 #include "picloudbase.h"
 #include "piconditionvar.h"
 
-
-//! \brief PICloudClient
-
+//! \~\ingroup Cloud
+//! \~\brief
+//! \~english %PIIODevice implementation for a logical PICloud client.
+//! \~russian Реализация %PIIODevice для логического клиента PICloud.
 class PIP_CLOUD_EXPORT PICloudClient
 	: public PIIODevice
 	, public PICloudBase {
 	PIIODEVICE(PICloudClient, "");
 
 public:
+	//! \~english Constructs a client for transport endpoint "path" and mode "mode".
+	//! \~russian Создает клиент для транспортной точки "path" и режима "mode".
 	explicit PICloudClient(const PIString & path = PIString(), PIIODevice::DeviceMode mode = PIIODevice::ReadWrite);
+
+	//! \~english Destroys the client and closes the underlying transport.
+	//! \~russian Уничтожает клиент и закрывает нижележащий транспорт.
 	virtual ~PICloudClient();
 
+
+	//! \~english Sets the logical server name used during the PICloud handshake.
+	//! \~russian Устанавливает логическое имя сервера, используемое при рукопожатии PICloud.
 	void setServerName(const PIString & server_name);
+
+	//! \~english Enables or disables automatic reconnect of the underlying TCP link.
+	//! \~russian Включает или выключает автоматическое переподключение нижележащего TCP-соединения.
 	void setKeepConnection(bool on);
+
+	//! \~english Returns whether the logical PICloud session is established.
+	//! \~russian Возвращает, установлена ли логическая сессия PICloud.
 	bool isConnected() const { return is_connected; }
+
+	//! \~english Returns the number of payload bytes buffered for \a read().
+	//! \~russian Возвращает количество байтов полезной нагрузки, буферизованных для \a read().
 	ssize_t bytesAvailable() const override { return buff.size(); }
+
+	//! \~english Interrupts pending connection and read waits.
+	//! \~russian Прерывает ожидающие операции подключения и чтения.
 	void interrupt() override;
 
+
+	//! \events
+	//! \{
+
+	//! \fn void connected()
+	//! \~english Raised after the logical PICloud session becomes ready.
+	//! \~russian Вызывается после того, как логическая сессия PICloud готова к работе.
 	EVENT(connected);
+
+	//! \fn void disconnected()
+	//! \~english Raised when the logical PICloud session is closed.
+	//! \~russian Вызывается при закрытии логической сессии PICloud.
 	EVENT(disconnected);
 
+	//! \}
+
 protected:
 	bool openDevice() override;
 	bool closeDevice() override;