doc, small fixes

libs/main/io_devices/pisharedmemory.cpp

@@ -40,25 +40,24 @@
 #endif
 
 
-/*! \class PISharedMemory
- * \brief Shared memory
- * 
- * \section  PISharedMemory_sec0 Synopsis
- * This class provide access to local file. You can manipulate
- * binary content or use this class as text stream. To binary
- * access there are function \a read(), \a write(), and many
- * \a writeBinary() functions. For write variables to file in
- * their text representation threr are many "<<" operators.
- * 
- * \section  PISharedMemory_sec1 Position
- * Each opened file has a read/write position - logical position
- * in the file content you read from or you write to. You can
- * find out current position with function \a pos(). Function
- * \a seek(llong position) move position to position "position",
- * \a seekToBegin() move position to the begin of file,
- * \a seekToEnd() move position to the end of file.
- * 
- */
+//! \class PISharedMemory pisharedmemory.h
+//! \details
+//! \~english
+//!
+//!
+//! \~russian
+//! Разделяемая память используется как единое хранилище данных,
+//! доступное различным процессам по имени. При первом открытии
+//! объекта разделяемой памяти выделяется \a size() байт, по умолчанию
+//! 65 Кб. Все процессы должны использовать один и тот же \a size()
+//! во избежании ошибок.
+//!
+//! У объекта разделяемой памяти нету позиции чтения/записи,
+//! каждый вызов \a read() или \a write() обращается
+//! к началу памяти. Для работы с конкретным участком памяти
+//! используются перегруженные методы с указанием "offset".
+//!
+
 
 REGISTER_DEVICE(PISharedMemory)