Changeset 60748 in vbox

Timestamp:

Apr 28, 2016 4:38:59 PM (9 years ago)

Author:

vboxsync

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

106940

Message:

doxygen fixes.

File:

• trunk/include/VBox/GuestHost/GuestControl.h (modified) (6 diffs)

trunk/include/VBox/GuestHost/GuestControl.h

@@ -73 +73 @@
 #define SESSIONCREATIONFLAG_NONE            0x0
 
-/**
- * Guest directory removement flags.
+/** @name DIRREMOVE_FLAG_XXX - Guest directory removement flags.
  * Essentially using what IPRT's RTDIRRMREC_F_
  * defines have to offer.
+ * @{
  */
 #define DIRREMOVE_FLAG_RECURSIVE            RT_BIT(0)
@@ -85 +85 @@
 /** Mask of valid flags. */
 #define DIRREMOVE_FLAG_VALID_MASK           UINT32_C(0x00000003)
+/** @}   */
 
-/** @name EXECUTEPROCESSFLAG_XXX Guest process creation flags.
+/** @name EXECUTEPROCESSFLAG_XXX - Guest process creation flags.
  * @note Has to match Main's ProcessCreateFlag_* flags!
+ * @{
  */
 #define EXECUTEPROCESSFLAG_NONE             UINT32_C(0x0)
@@ -93 +95 @@
 #define EXECUTEPROCESSFLAG_IGNORE_ORPHANED  RT_BIT(1)
 #define EXECUTEPROCESSFLAG_HIDDEN           RT_BIT(2)
-#define EXECUTEPROCESSFLAG_NO_PROFILE       RT_BIT(3) /** @todo Rename to EXECUTEPROCESSFLAG_PROFILE in next API change. */
+#define EXECUTEPROCESSFLAG_NO_PROFILE       RT_BIT(3) /**< @todo Rename to EXECUTEPROCESSFLAG_PROFILE in next API change. */
 #define EXECUTEPROCESSFLAG_WAIT_STDOUT      RT_BIT(4)
 #define EXECUTEPROCESSFLAG_WAIT_STDERR      RT_BIT(5)
@@ -100 +102 @@
 /** @} */
 
-/**
- * Pipe handle IDs used internally for referencing to
- * a certain pipe buffer.
+/** @name OUTPUT_HANDLE_ID_XXX - Pipe handle IDs used internally for referencing
+ *        to a certain pipe buffer.
+ * @{
  */
-#define OUTPUT_HANDLE_ID_STDOUT_DEPRECATED  0 /* Needed for VBox hosts < 4.1.0. */
+#define OUTPUT_HANDLE_ID_STDOUT_DEPRECATED  0 /**< Needed for VBox hosts < 4.1.0. */
 #define OUTPUT_HANDLE_ID_STDOUT             1
 #define OUTPUT_HANDLE_ID_STDERR             2
+/** @} */
 
-/**
- * Guest path rename flags.
- * Essentially using what IPRT's RTPATHRENAME_FLAGS_
- * defines have to offer.
+/** @name PATHRENAME_FLAG_XXX - Guest path rename flags.
+ * Essentially using what IPRT's RTPATHRENAME_FLAGS_XXX have to offer.
+ * @{
  */
 /** Do not replace anything. */
@@ -121 +123 @@
 /** Mask of valid flags. */
 #define PATHRENAME_FLAG_VALID_MASK          UINT32_C(0x00000002)
+/** @} */
 
-/**
- * Defines for guest process array lengths.
+/** @name Defines for guest process array lengths.
+ * @{
  */
 #define GUESTPROCESS_MAX_CMD_LEN            _1K
@@ -131 +134 @@
 #define GUESTPROCESS_MAX_PASSWORD_LEN       128
 #define GUESTPROCESS_MAX_DOMAIN_LEN         256
+/** @} */
 
-/** @name 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.
  * @{
  */