Changeset 69 in pacpusframework for trunk/include/Pacpus/PacpusTools/Win32ShMem.h

Timestamp:

01/10/13 00:04:42 (11 years ago)

Author:

Marek Kurdej

Message:

Added: more documentation.

File:

• trunk/include/Pacpus/PacpusTools/Win32ShMem.h (modified) (1 diff)

trunk/include/Pacpus/PacpusTools/Win32ShMem.h

@@ -17 +17 @@
 #include <Pacpus/PacpusTools/ShMemBase.h>
 
+/// Windows handle (opaque pointer) type definition
+/// 
+/// Forward declaration of typedefs is impossible.
 typedef void * HANDLE;
 
+/// Shared memory object for Windows.
 class Win32ShMem
         : public ShMemBase
 {
 public:
+    /// Ctor
     Win32ShMem(const char * name, int size);
+    /// Dtor
     ~Win32ShMem();
 
+    /// @todo Documentation
     virtual bool wait(unsigned long timeout = 0);
+    /// @todo Documentation
     virtual void * read();
+    /// @todo Documentation
     virtual void read(void * mem, int size);
+    /// @todo Documentation
     virtual void write(void * data, int size, unsigned long offset = 0);
+    /// @todo Documentation
     virtual void lockMemory();
+    /// @todo Documentation
     virtual void unlockMemory();
+    /// @todo Documentation
     virtual void * getEventIdentifier();