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

Timestamp:

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

Author:

Marek Kurdej

Message:

Added: more documentation.

File:

• trunk/include/Pacpus/PacpusTools/ShMem.h (modified) (3 diffs)

trunk/include/Pacpus/PacpusTools/ShMem.h

@@ -16 +16 @@
 #ifdef WIN32
 #   include "Win32ShMem.h"
+/// Defines shared memory as a Windows shared memory
 #   define ShMemType Win32ShMem
 #else
 #   include "PosixShMem.h"
+/// Defines shared memory as a POSIX shared memory
 #   define ShMemType PosixShMem
 #endif
@@ -24 +26 @@
 namespace pacpus {
 
+/// Shared memory class.
+///
+/// Inherits from Win32ShMem on Windows system and from PosixShMem on Unix-like systems.
 class ShMem
-        : public ShMemType
+    : public ShMemType
 {
 public:
-    /// @brief Ctor of shared memory class.
+    /// Ctor of shared memory class.
     ///
     /// Creates a shared memory of size @b size and named @b name.
@@ -43 +48 @@
     }
 
-    /// @brief Dtor of shared memory class.
+    /// Dtor of shared memory class.
     ///
     /// Does nothing.