merged AI doc, some new pages

libs/main/cloud/picloudserver.h

@@ -1,9 +1,8 @@
-/*! \file picloudserver.h
- * \ingroup Cloud
- * \~\brief
- * \~english PICloud Server
- * \~russian Сервер PICloud
- */
+//! \~\file picloudserver.h
+//! \~\ingroup Cloud
+//! \~\brief
+//! \~english Server-side PICloud device for one named endpoint
+//! \~russian Серверное устройство PICloud для одной именованной конечной точки
 /*
     PIP - Platform Independent Primitives
     PICloud Server
@@ -29,23 +28,43 @@
 #include "picloudbase.h"
 #include "piconditionvar.h"
 
-
+//! \~\ingroup Cloud
+//! \~\brief
+//! \~english %PIIODevice implementation for a logical PICloud server.
+//! \~russian Реализация %PIIODevice для логического сервера PICloud.
 class PIP_CLOUD_EXPORT PICloudServer
 	: public PIIODevice
 	, public PICloudBase {
 	PIIODEVICE(PICloudServer, "");
 
 public:
-	//! PICloudServer
+	//! \~english Constructs a logical server for transport endpoint "path" and mode "mode".
+	//! \~russian Создает логический сервер для транспортной точки "path" и режима "mode".
 	explicit PICloudServer(const PIString & path = PIString(), PIIODevice::DeviceMode mode = PIIODevice::ReadWrite);
+
+	//! \~english Destroys the server and closes all logical clients.
+	//! \~russian Уничтожает сервер и закрывает всех логических клиентов.
 	virtual ~PICloudServer();
 
+
+	//! \~\ingroup Cloud
+	//! \~\brief
+	//! \~english Per-client %PIIODevice exposed by %PICloudServer.
+	//! \~russian Клиентское %PIIODevice, предоставляемое %PICloudServer.
+	//! \~\details
+	//! \~english Instances are created by \a newConnection() and represent one logical cloud client.
+	//! \~russian Экземпляры создаются через \a newConnection() и представляют одного логического облачного клиента.
 	class Client: public PIIODevice {
 		PIIODEVICE(PICloudServer::Client, "");
 		friend class PICloudServer;
 
 	public:
+		//! \~english Constructs a wrapper for logical client "id" owned by server "srv".
+		//! \~russian Создает обертку для логического клиента "id", принадлежащего серверу "srv".
 		Client(PICloudServer * srv = nullptr, uint id = 0);
+
+		//! \~english Destroys the client wrapper.
+		//! \~russian Уничтожает клиентскую обертку.
 		virtual ~Client();
 
 	protected:
@@ -67,12 +86,25 @@ public:
 		std::atomic_bool is_connected;
 	};
 
+	//! \~english Sets the logical server name announced by this server.
+	//! \~russian Устанавливает логическое имя сервера, объявляемое этим сервером.
 	void setServerName(const PIString & server_name);
 
+	//! \~english Returns a snapshot of the currently connected logical clients.
+	//! \~russian Возвращает снимок текущих подключенных логических клиентов.
 	PIVector<PICloudServer::Client *> clients() const;
 
+
+	//! \events
+	//! \{
+
+	//! \fn void newConnection(PICloudServer::Client * client)
+	//! \~english Raised when a new logical client appears for this server name.
+	//! \~russian Вызывается, когда для этого имени сервера появляется новый логический клиент.
 	EVENT1(newConnection, PICloudServer::Client *, client);
 
+	//! \}
+
 protected:
 	bool openDevice() override;
 	bool closeDevice() override;