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

Timestamp:

01/09/13 19:17:44 (11 years ago)

Author:

Marek Kurdej

Message:

Documentation: file info.
Fixed: problem with includes in PacpusPluginInterface.h.

File:

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

trunk/include/Pacpus/PacpusTools/ShMem.h

@@ -28 +28 @@
 {
 public:
+    /// @brief Ctor of shared memory class.
+    ///
+    /// Creates a shared memory of size @b size and named @b name.
+    /// If a shared memory with the name @b name already exists, than
+    /// it will return object pointing to the same memory.
+    /// If this existing memory space has a size smaller than @b size,
+    /// a warning will be issued.
+    ///
+    /// @param name Name of the created shared memory space.
+    /// @param size Size of the created shared memory space in [bytes].
     ShMem(const char * name, int size)
         : ShMemType(name, size)
@@ -33 +43 @@
     }
 
+    /// @brief Dtor of shared memory class.
+    ///
+    /// Does nothing.
     ~ShMem()
     {