Changeset 81369 in vbox for trunk/include/VBox

Timestamp:

Oct 18, 2019 9:13:03 PM (5 years ago)

Author:

vboxsync

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

134082

Message:

*: doxygen fixes

Location:

trunk/include/VBox

Files:

• GuestHost/clipboard-helper.h (modified) (1 diff)
• VMMDev.h (modified) (4 diffs)
• types.h (modified) (1 diff)
• vd-ifs-internal.h (modified) (2 diffs)
• vd-ifs.h (modified) (1 diff)
• vmm/cpum.h (modified) (2 diffs)
• vmm/cpumctx.h (modified) (1 diff)
• vmm/hm_svm.h (modified) (1 diff)
• vmm/pdmcommon.h (modified) (2 diffs)
• vmm/vmapi.h (modified) (1 diff)

trunk/include/VBox/GuestHost/clipboard-helper.h

@@ -82 +82 @@
  * @param   pwszSrc  The source UTF-16 string
  * @param   cwcSrc   The length of the source string in RTUTF16 units.
- * @retval  pcwcDst  The length of the destination string in RTUTF16 units.
+ * @param   pcwcDst  The length of the destination string in RTUTF16 units.
  */
 int ShClUtf16GetLinSize(PRTUTF16 pwszSrc, size_t cwcSrc, size_t *pcwcDst);

trunk/include/VBox/VMMDev.h

@@ -85 +85 @@
  * @remarks These defines also live in the 16-bit and assembly versions of this
  *          header.
+ * @{
  */
 #define VMMDEV_VERSION                      0x00010004
@@ -1853 +1854 @@
 }
 
-/** @} */
 
 /** @name VBVA ring defines.
@@ -1872 +1872 @@
  * until the record is completed.
  *
- */
+ * @{ */
 #define VMMDEV_VBVA_RING_BUFFER_SIZE        (_4M - _1K)
 #define VMMDEV_VBVA_RING_BUFFER_THRESHOLD   (4 * _1K)
@@ -1965 +1965 @@
 /** @} */
 
+/** @} */
 RT_C_DECLS_END
 #pragma pack()

trunk/include/VBox/types.h

@@ -831 +831 @@
 } VBOXIDTR, *PVBOXIDTR;
 #pragma pack()
-
-/** @} */
 
 

trunk/include/VBox/vd-ifs-internal.h

@@ -34 +34 @@
 
 RT_C_DECLS_BEGIN
+
+/** @addtogroup grp_vd
+ * @internal
+ * @{ */
 
 /**
@@ -684 +688 @@
 }
 
+/** @} */
 RT_C_DECLS_END
 
-/** @} */
-
 #endif /* !VBOX_INCLUDED_vd_ifs_internal_h */

trunk/include/VBox/vd-ifs.h

@@ -41 +41 @@
 
 RT_C_DECLS_BEGIN
+
+/** @addtogroup grp_vd
+ * @{ */
 
 /** Interface header magic. */

trunk/include/VBox/vmm/cpum.h

@@ -1572 +1572 @@
 /** @} */
 
-#if !defined(IPRT_WITHOUT_NAMED_UNIONS_AND_STRUCTS) && defined(RT_ARCH_AMD64)
+#if (!defined(IPRT_WITHOUT_NAMED_UNIONS_AND_STRUCTS) && defined(RT_ARCH_AMD64)) || defined(DOXYGEN_RUNNING)
+/** @name Inlined Guest Getters and predicates Functions.
+ * @{ */
 
 /**
@@ -2515 +2517 @@
 }
 
+/** @} */
 #endif /* !IPRT_WITHOUT_NAMED_UNIONS_AND_STRUCTS && RT_ARCH_AMD64 */
 
-/** @} */
 
 

trunk/include/VBox/vmm/cpumctx.h

@@ -639 +639 @@
         uint8_t                 abPadding0[48];
     } hwvirt;
-    /** @} */
 } CPUMCTX;
 #pragma pack()

trunk/include/VBox/vmm/hm_svm.h

@@ -1156 +1156 @@
     } while (0)
 
-/** @def HMSVM_SEG_REG_COPY_TO_VMCB
+/** @def HMSVM_SEG_REG_COPY_FROM_VMCB
  * Copies the specified segment register from the VMCB to a virtual CPU
  * context.

trunk/include/VBox/vmm/pdmcommon.h

@@ -90 +90 @@
 
 
-/** PDM Attach/Detach Callback Flags.
+/** @name PDM Attach/Detach Callback Flags.
  * Used by PDMDeviceAttach, PDMDeviceDetach, PDMDriverAttach, PDMDriverDetach,
  * FNPDMDEVATTACH, FNPDMDEVDETACH, FNPDMDRVATTACH, FNPDMDRVDETACH and
  * FNPDMDRVCONSTRUCT.
- @{ */
+ * @{ */
 /** The attach/detach command is not a hotplug event. */
 #define PDM_TACH_FLAGS_NOT_HOT_PLUG     RT_BIT_32(0)
@@ -100 +100 @@
  * This is mostly for internal use.  */
 #define PDM_TACH_FLAGS_NO_CALLBACKS     RT_BIT_32(1)
-/* @} */
+/** @} */
 
 

trunk/include/VBox/vmm/vmapi.h

@@ -270 +270 @@
 typedef VMREQ *PVMREQ;
 
-/** @} */
-
 
 #ifndef IN_RC