merged AI doc, some new pages

libs/main/io_devices/pican.h

@@ -1,9 +1,8 @@
-/*! \file pican.h
- * \ingroup IO
- * \~\brief
- * \~english CAN device
- * \~russian Устройство CAN
- */
+//! \~\file pican.h
+//! \~\ingroup IO
+//! \~\brief
+//! \~english CAN bus device wrapper
+//! \~russian Обертка над устройством шины CAN
 /*
     PIP - Platform Independent Primitives
     CAN
@@ -29,16 +28,36 @@
 #include "piiodevice.h"
 
 
+//! \~\ingroup IO
+//! \~\brief
+//! \~english CAN device based on interface name and frame identifier.
+//! \~russian CAN-устройство, настраиваемое именем интерфейса и идентификатором кадра.
 class PIP_EXPORT PICAN: public PIIODevice {
 	PIIODEVICE(PICAN, "can");
 
 public:
+	//!  \~english Constructs a CAN device for interface "path".
+	//! \~russian Создает CAN-устройство для интерфейса "path".
 	explicit PICAN(const PIString & path = PIString(), PIIODevice::DeviceMode mode = PIIODevice::ReadWrite);
+
+	//! \~english Destroys the CAN device.
+	//! \~russian Уничтожает CAN-устройство.
 	virtual ~PICAN();
 
+	//! \~english Sets CAN frame identifier for subsequent \a write() calls.
+	//! \~russian Устанавливает идентификатор CAN-кадра для последующих вызовов \a write().
 	void setCANID(int id);
+
+	//! \~english Returns CAN frame identifier used by \a write().
+	//! \~russian Возвращает идентификатор CAN-кадра, используемый методом \a write().
 	int CANID() const;
+
+	//! \~english Returns identifier of the last frame received by \a read().
+	//! \~russian Возвращает идентификатор последнего кадра, полученного методом \a read().
 	int readedCANID() const;
+
+	//! \~english Interrupts a blocking CAN wait operation.
+	//! \~russian Прерывает блокирующее ожидание CAN-кадра.
 	void interrupt() override;
 
 protected: