Changeset 34556 in vbox for trunk/include/VBox

Timestamp:

Dec 1, 2010 10:43:44 AM (14 years ago)

Author:

vboxsync

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

68347

Message:

GuestControlSvc.h: a bit of doxygen, dropping leading underscores

Location:

trunk/include/VBox/HostServices

Files:

• GuestControlSvc.h (modified) (19 diffs)
• Makefile.kup (added)

trunk/include/VBox/HostServices/GuestControlSvc.h

@@ -1 +1 @@
 /** @file
- * Guest control service:
- * Common header for host service and guest clients.
+ * Guest control service - Common header for host service and guest clients.
  */
 
@@ -36 +35 @@
 #include <iprt/string.h>
 
-/** Everything defined in this file lives in this namespace. */
+/* Everything defined in this file lives in this namespace. */
 namespace guestControl {
 
@@ -76 +75 @@
 #define INPUT_FLAG_EOF              RT_BIT(0)
 
-/*
- * Internal tools built into VBoxService which are
- * used in order to accomplish tasks host<->guest.
+/** @name Internal tools built into VBoxService which are used in order to
+ *        accomplish tasks host<->guest.
+ * @{
  */
 #define VBOXSERVICE_TOOL_CAT        "vbox_cat"
 #define VBOXSERVICE_TOOL_MKDIR      "vbox_mkdir"
+/** @} */
 
 /**
@@ -100 +100 @@
 };
 
-typedef struct _VBoxGuestCtrlCallbackHeader
+/**
+ * Document me.
+ */
+typedef struct VBoxGuestCtrlCallbackHeader
 {
     /** Magic number to identify the structure. */
@@ -106 +109 @@
     /** Context ID to identify callback data. */
     uint32_t u32ContextID;
-} CALLBACKHEADER, *PCALLBACKHEADER;
+} CALLBACKHEADER;
+typedef CALLBACKHEADER *PCALLBACKHEADER;
 
 /**
@@ -112 +116 @@
  * notify the host of changes to properties.
  */
-typedef struct _VBoxGuestCtrlCallbackDataExecStatus
+typedef struct VBoxGuestCtrlCallbackDataExecStatus
 {
     /** Callback data header. */
@@ -118 +122 @@
     /** The process ID (PID). */
     uint32_t u32PID;
-    /* The process status. */
+    /** The process status. */
     uint32_t u32Status;
     /** Optional flags, varies, based on u32Status. */
@@ -126 +130 @@
     /** Size of optional data buffer (not used atm). */
     uint32_t cbData;
-} CALLBACKDATAEXECSTATUS, *PCALLBACKDATAEXECSTATUS;
-
-typedef struct _VBoxGuestCtrlCallbackDataExecOut
+} CALLBACKDATAEXECSTATUS;
+typedef CALLBACKDATAEXECSTATUS *PCALLBACKDATAEXECSTATUS;
+
+typedef struct VBoxGuestCtrlCallbackDataExecOut
 {
     /** Callback data header. */
@@ -134 +139 @@
     /** The process ID (PID). */
     uint32_t u32PID;
-    /* The handle ID (stdout/stderr). */
+    /** The handle ID (stdout/stderr). */
     uint32_t u32HandleId;
     /** Optional flags (not used atm). */
@@ -142 +147 @@
     /** Size (in bytes) of optional data buffer. */
     uint32_t cbData;
-} CALLBACKDATAEXECOUT, *PCALLBACKDATAEXECOUT;
-
-typedef struct _VBoxGuestCtrlCallbackDataExecInStatus
+} CALLBACKDATAEXECOUT;
+typedef CALLBACKDATAEXECOUT *PCALLBACKDATAEXECOUT;
+
+typedef struct VBoxGuestCtrlCallbackDataExecInStatus
 {
     /** Callback data header. */
@@ -156 +162 @@
     /** Size (in bytes) of processed input data. */
     uint32_t cbProcessed;
-} CALLBACKDATAEXECINSTATUS, *PCALLBACKDATAEXECINSTATUS;
-
-typedef struct _VBoxGuestCtrlCallbackDataClientDisconnected
+} CALLBACKDATAEXECINSTATUS;
+typedef CALLBACKDATAEXECINSTATUS *PCALLBACKDATAEXECINSTATUS;
+
+typedef struct VBoxGuestCtrlCallbackDataClientDisconnected
 {
     /** Callback data header. */
     CALLBACKHEADER hdr;
-} CALLBACKDATACLIENTDISCONNECTED, *PCALLBACKDATACLIENTDISCONNECTED;
+} CALLBACKDATACLIENTDISCONNECTED;
+typedef CALLBACKDATACLIENTDISCONNECTED *PCALLBACKDATACLIENTDISCONNECTED;
 
 enum
@@ -249 +257 @@
  */
 #pragma pack (1)
-typedef struct _VBoxGuestCtrlHGCMMsgType
+
+typedef struct VBoxGuestCtrlHGCMMsgType
 {
     VBoxGuestHGCMCallInfo hdr;
@@ -264 +273 @@
 
 /**
- * Asks the guest control host service to cancel all pending
- * (outstanding) waits which were not processed yet. This is
- * handy for a graceful shutdown.
- */
-typedef struct _VBoxGuestCtrlHGCMMsgCancelPendingWaits
+ * Asks the guest control host service to cancel all pending (outstanding)
+ * waits which were not processed yet.  This is handy for a graceful shutdown.
+ */
+typedef struct VBoxGuestCtrlHGCMMsgCancelPendingWaits
 {
     VBoxGuestHGCMCallInfo hdr;
@@ -276 +284 @@
  * Executes a command inside the guest.
  */
-typedef struct _VBoxGuestCtrlHGCMMsgExecCmd
+typedef struct VBoxGuestCtrlHGCMMsgExecCmd
 {
     VBoxGuestHGCMCallInfo hdr;
@@ -308 +316 @@
 
 /**
- * Injects input to a previously executed process via
- * stdin.
- */
-typedef struct _VBoxGuestCtrlHGCMMsgExecIn
+ * Injects input to a previously executed process via stdin.
+ */
+typedef struct VBoxGuestCtrlHGCMMsgExecIn
 {
     VBoxGuestHGCMCallInfo hdr;
@@ -327 +334 @@
 } VBoxGuestCtrlHGCMMsgExecIn;
 
-typedef struct _VBoxGuestCtrlHGCMMsgExecOut
+typedef struct VBoxGuestCtrlHGCMMsgExecOut
 {
     VBoxGuestHGCMCallInfo hdr;
@@ -343 +350 @@
 } VBoxGuestCtrlHGCMMsgExecOut;
 
-typedef struct _VBoxGuestCtrlHGCMMsgExecStatus
+typedef struct VBoxGuestCtrlHGCMMsgExecStatus
 {
     VBoxGuestHGCMCallInfo hdr;
@@ -359 +366 @@
 } VBoxGuestCtrlHGCMMsgExecStatus;
 
-typedef struct _VBoxGuestCtrlHGCMMsgExecStatusIn
+typedef struct VBoxGuestCtrlHGCMMsgExecStatusIn
 {
     VBoxGuestHGCMCallInfo hdr;
@@ -374 +381 @@
 
 } VBoxGuestCtrlHGCMMsgExecStatusIn;
+
 #pragma pack ()
 
-/* Structure for buffering execution requests in the host service. */
-typedef struct _VBoxGuestCtrlParamBuffer
+/**
+ * Structure for buffering execution requests in the host service.
+ */
+typedef struct VBoxGuestCtrlParamBuffer
 {
     uint32_t uMsg;
     uint32_t uParmCount;
     VBOXHGCMSVCPARM *pParms;
-} VBOXGUESTCTRPARAMBUFFER, *PVBOXGUESTCTRPARAMBUFFER;
+} VBOXGUESTCTRPARAMBUFFER;
+typedef VBOXGUESTCTRPARAMBUFFER *PVBOXGUESTCTRPARAMBUFFER;
 
 } /* namespace guestControl */
 
-#endif  /* ___VBox_HostService_GuestControlService_h defined */
+#endif  /* !___VBox_HostService_GuestControlService_h */
+