Changeset 71585 in vbox for trunk

Timestamp:

Mar 31, 2018 12:48:37 PM (7 years ago)

Author:

vboxsync

Message:

HGSMI.h: docs

File:

• trunk/include/VBox/Graphics/HGSMI.h (modified) (4 diffs)

trunk/include/VBox/Graphics/HGSMI.h

@@ -39 +39 @@
 #include "HGSMIMemAlloc.h"
 
-/*
+/**
  * Basic mechanism for the HGSMI is to prepare and pass data buffer to the host and the guest.
  * Data inside these buffers are opaque for the HGSMI and are interpreted by higher levels.
@@ -76 +76 @@
 typedef struct HGSMIHEAP
 {
-    HGSMIAREA area; /* Description. */
-    HGSMIMADATA ma; /* Memory allocator */
+    HGSMIAREA area; /**< Description. */
+    HGSMIMADATA ma; /**< Memory allocator */
 } HGSMIHEAP;
 
@@ -83 +83 @@
 #define HGSMI_NUMBER_OF_CHANNELS 0x100
 
-/* Channel handler called when the guest submits a buffer. */
+/**
+ * Channel handler called when the guest submits a buffer.
+ *
+ * @returns stuff
+ * @param   pvHandler       Value specified when registring.
+ * @param   u16ChannelInfo  Command code.
+ * @param   pvBuffer        HGSMI buffer with command data.  This is shared with
+ *                          the guest.  Consider untrusted and volatile!
+ * @param   cbBuffer        Size of command data.
+ * @thread  EMT on the host side.
+ */
 typedef DECLCALLBACK(int) FNHGSMICHANNELHANDLER(void *pvHandler, uint16_t u16ChannelInfo, void *pvBuffer, HGSMISIZE cbBuffer);
+/** Pointer to a channel handler callback. */
 typedef FNHGSMICHANNELHANDLER *PFNHGSMICHANNELHANDLER;
 
-/* Information about a handler: pfn + context. */
+/** Information about a handler: pfn + context. */
 typedef struct _HGSMICHANNELHANDLER
 {
@@ -94 +105 @@
 } HGSMICHANNELHANDLER;
 
-/* Channel description. */
+/** Channel description. */
 typedef struct _HGSMICHANNEL
 {
-    HGSMICHANNELHANDLER handler;       /* The channel handler. */
-    const char *pszName;               /* NULL for hardcoded channels or RTStrDup'ed name. */
-    uint8_t u8Channel;                 /* The channel id, equal to the channel index in the array. */
-    uint8_t u8Flags;                   /* HGSMI_CH_F_* */
+    HGSMICHANNELHANDLER handler;       /**< The channel handler. */
+    const char *pszName;               /**< NULL for hardcoded channels or RTStrDup'ed name. */
+    uint8_t u8Channel;                 /**< The channel id, equal to the channel index in the array. */
+    uint8_t u8Flags;                   /**< HGSMI_CH_F_* */
 } HGSMICHANNEL;
 
 typedef struct _HGSMICHANNELINFO
 {
-    HGSMICHANNEL Channels[HGSMI_NUMBER_OF_CHANNELS]; /* Channel handlers indexed by the channel id.
-                                                      * The array is accessed under the instance lock.
-                                                      */
+    /** Channel handlers indexed by the channel id.
+     * The array is accessed under the instance lock. */
+    HGSMICHANNEL Channels[HGSMI_NUMBER_OF_CHANNELS];
 }  HGSMICHANNELINFO;