Changeset 70604 in vbox for trunk/include

Timestamp:

Jan 16, 2018 6:03:18 PM (7 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

120315

Message:

DevVGA: cleanup in progress.

File:

• trunk/include/VBox/Graphics/HGSMIDefs.h (modified) (1 diff)

trunk/include/VBox/Graphics/HGSMIDefs.h

@@ -41 +41 @@
 #define HGSMIOFFSET_VOID ((HGSMIOFFSET)~0)
 
-/* Describes a shared memory area buffer.
+/**
+ * Describes a shared memory area buffer.
+ *
  * Used for calculations with offsets and for buffers verification.
  */
 typedef struct HGSMIAREA
 {
-    uint8_t     *pu8Base; /* The starting address of the area. Corresponds to offset 'offBase'. */
-    HGSMIOFFSET  offBase; /* The starting offset of the area. */
-    HGSMIOFFSET  offLast; /* The last valid offset:
-                           * offBase + cbArea - 1 - (sizeof(header) + sizeof(tail)).
-                           */
-    HGSMISIZE    cbArea;  /* Size of the area. */
+    uint8_t     *pu8Base; /**< The starting address of the area. Corresponds to offset 'offBase'. */
+    HGSMIOFFSET  offBase; /**< The starting offset of the area. */
+    HGSMIOFFSET  offLast; /**< The last valid offset:  offBase + cbArea - 1 - (sizeof(header) + sizeof(tail)). */
+    HGSMISIZE    cbArea;  /**< Size of the area. */
 } HGSMIAREA;