doc, small fixes

libs/main/io_devices/pisharedmemory.h

@@ -29,47 +29,64 @@
 #include "piiodevice.h"
 
 
+//! \ingroup IO
+//! \~\brief
+//! \~english Shared memory.
+//! \~russian Разделяемая память.
 class PIP_EXPORT PISharedMemory: public PIIODevice
 {
 	PIIODEVICE(PISharedMemory, "shm")
 public:
 	
+	//! \~english Constructs empty %PISharedMemory
+	//! \~russian Создает пустой %PISharedMemory
 	explicit PISharedMemory();
 		
-	//! Constructs a shared memory object with name "shm_name", size "size" and open mode "mode"
+	//! \~english Constructs a shared memory object with name "shm_name", size "size" and open mode "mode"
+	//! \~russian Создает объект разделяемой памяти с именем "shm_name", размером "size" и режимом открытия "mode"
 	explicit PISharedMemory(const PIString & shm_name, int size, DeviceMode mode = ReadWrite);
 	
-	
 	virtual ~PISharedMemory();
+
 	
-	//! Read all shared memory object content to byte array and return it
+	//! \~english Read all shared memory content and return it as byte array
+	//! \~russian Читает всю разделяемую память и возвращает её как байтовый массив
 	PIByteArray readAll();
 	
-	//! Returns shared memory object size
+	//! \~english Returns shared memory size
+	//! \~russian Возвращает размер разделяемой памяти
 	llong size() const;
 
-	//! Set shared memory object size
+	//! \~english Set shared memory size
+	//! \~russian Устанавливает размер разделяемой памяти
 	void setSize(llong s);
 	
-	//! Returns if shared memory object is empty
+	//! \~english Returns if shared memory object is empty (by size)
+	//! \~russian Возвращает пустой ли объект разделяемой памяти (по размеру)
 	bool isEmpty() const {return (size() <= 0);}
 	
-	//! Read from shared memory object to "read_to" no more than "max_size" and return readed bytes count
+	//! \~english Read from shared memory to "read_to" no more than "max_size" and return readed bytes count
+	//! \~russian Читает из разделяемой памяти в "read_to" не более "max_size" и возвращает количество прочитанных байт
 	int read(void * read_to, int max_size);
 
-	//! Read from shared memory object to "read_to" no more than "max_size" and return readed bytes count
+	//! \~english Read from shared memory started from "offset" to "read_to" no more than "max_size" and return readed bytes count
+	//! \~russian Читает из разделяемой памяти с начала "offset" в "read_to" не более "max_size" и возвращает количество прочитанных байт
 	int read(void * read_to, int max_size, int offset);
 	
-	//! Write to shared memory object "data" with size "max_size" and return written bytes count
+	//! \~english Write to shared memory "data" with size "max_size" and return written bytes count
+	//! \~russian Пишет в разделяемую память "data" размером "max_size" и возвращает количество записанных байт
 	int write(const void * data, int max_size);
 
-	//! Write to shared memory object "data" with size "max_size" and return written bytes count
+	//! \~english Write to shared memory started from "offset" "data" with size "max_size" and return written bytes count
+	//! \~russian Пишет в разделяемую память с начала "offset" "data" размером "max_size" и возвращает количество записанных
 	int write(const void * data, int max_size, int offset);
 
-	//! Write "data" to shared memory object
+	//! \~english Write "data" to shared memory
+	//! \~russian Пишет в разделяемую память "data"
 	int write(const PIByteArray & data) {return write(data.data(), data.size_s());}
 
-	//! Write "data" to shared memory object
+	//! \~english Write "data" to shared memory
+	//! \~russian Пишет в разделяемую память "data"
 	int write(const PIByteArray & data, int offset) {return write(data.data(), data.size_s(), offset);}