Changeset 58106 in vbox for trunk/src/VBox/VMM/include

Timestamp:

Oct 7, 2015 5:07:25 PM (9 years ago)

Author:

vboxsync

Message:

include,misc: Corrected a bunch of doxygen errors.

Location:

trunk/src/VBox/VMM/include

Files:

• HMInternal.h (modified) (6 diffs)
• PDMInternal.h (modified) (3 diffs)
• PGMInternal.h (modified) (7 diffs)
• TRPMInternal.h (modified) (8 diffs)
• VMMInternal.h (modified) (3 diffs)

trunk/src/VBox/VMM/include/HMInternal.h

@@ -49 +49 @@
 /** @def HM_PROFILE_EXIT_DISPATCH
  * Enables profiling of the VM exit handler dispatching. */
-#if 0
+#if 0 || defined(DOXYGEN_RUNNING)
 # define HM_PROFILE_EXIT_DISPATCH
 #endif
@@ -127 +127 @@
 
 
-/** Resets/initializes the VM-exit/#VMEXIT history array. */
+/** Resets/initializes the VM-exit/\#VMEXIT history array. */
 #define HMCPU_EXIT_HISTORY_RESET(pVCpu)           (memset(&(pVCpu)->hm.s.auExitHistory, 0xff, sizeof((pVCpu)->hm.s.auExitHistory)))
 
-/** Updates the VM-exit/#VMEXIT history array. */
+/** Updates the VM-exit/\#VMEXIT history array. */
 #define HMCPU_EXIT_HISTORY_ADD(pVCpu, a_ExitReason) \
     do { \
@@ -623 +623 @@
     /** Whether we're using the hyper DR7 or guest DR7. */
     bool                        fUsingHyperDR7;
-    /** Whether to preload the guest-FPU state to avoid #NM VM-exit overhead. */
+    /** Whether to preload the guest-FPU state to avoid \#NM VM-exit overhead. */
     bool                        fPreloadGuestFpu;
     /** Set if XCR0 needs to be loaded and saved when entering and exiting guest
@@ -629 +629 @@
     bool                        fLoadSaveGuestXcr0;
 
-    /** Whether #UD needs to be intercepted (required by certain GIM providers). */
+    /** Whether \#UD needs to be intercepted (required by certain GIM providers). */
     bool                        fGIMTrapXcptUD;
     /** Whether paravirt. hypercalls are enabled. */
@@ -871 +871 @@
     RTCPUID                 idEnteredCpu;
 
-    /** VT-x/AMD-V VM-exit/#VMXEXIT history, circular array. */
+    /** VT-x/AMD-V VM-exit/\#VMXEXIT history, circular array. */
     uint16_t                auExitHistory[31];
     /** The index of the next free slot in the history array. */
@@ -903 +903 @@
     STAMCOUNTER             StatExitShadowNM;
     STAMCOUNTER             StatExitGuestNM;
-    STAMCOUNTER             StatExitShadowPF;       /* Misleading, currently used for MMIO #PFs as well. */
+    STAMCOUNTER             StatExitShadowPF;       /**< Misleading, currently used for MMIO \#PFs as well. */
     STAMCOUNTER             StatExitShadowPFEM;
     STAMCOUNTER             StatExitGuestPF;

trunk/src/VBox/VMM/include/PDMInternal.h

@@ -294 +294 @@
     PVMRC                           pVMRC;
     /** Set if this critical section is the automatically created default
-     * section of a device.. */
+     * section of a device. */
     bool                            fAutomaticDefaultCritsect;
     /** Set if the critical section is used by a timer or similar.
@@ -689 +689 @@
     /** @copydoc PDMPCIBUSREG::pfnRegisterR3 */
     DECLR3CALLBACKMEMBER(int,       pfnRegisterR3,(PPDMDEVINS pDevIns, PPCIDEVICE pPciDev, const char *pszName, int iDev));
-    /** @copydoc PDMPCIBUSREG::pfnPCIRegisterMsiR3 */
+    /** @copydoc PDMPCIBUSREG::pfnRegisterMsiR3 */
     DECLR3CALLBACKMEMBER(int,       pfnRegisterMsiR3,(PPDMDEVINS pDevIns, PPCIDEVICE pPciDev, PPDMMSIREG pMsiReg));
     /** @copydoc PDMPCIBUSREG::pfnIORegionRegisterR3 */
@@ -977 +977 @@
         } SetIRQ;
 
-        /** Expanding the structure.. */
+        /** Expanding the structure. */
         uint64_t    au64[2];
     } u;

trunk/src/VBox/VMM/include/PGMInternal.h

@@ -152 +152 @@
 /** @def VBOX_WITH_NEW_LAZY_PAGE_ALLOC
  * Enables the experimental lazy page allocation code. */
-/*#define VBOX_WITH_NEW_LAZY_PAGE_ALLOC */
+#ifdef DOXYGEN_RUNNING
+# define VBOX_WITH_NEW_LAZY_PAGE_ALLOC
+#endif
 
 /** @def VBOX_WITH_REAL_WRITE_MONITORED_PAGES
  * Enables real write monitoring of pages, i.e. mapping them read-only and
- * only making them writable when getting a write access #PF. */
+ * only making them writable when getting a write access \#PF. */
 #define VBOX_WITH_REAL_WRITE_MONITORED_PAGES
 
@@ -876 +878 @@
  * Initializes the page structure.
  * @param   a_pPage     Pointer to the physical guest page tracking structure.
+ * @param   a_HCPhys    The host physical address of the page.
+ * @param   a_idPage    The (GMM) page ID of the page.
+ * @param   a_uType     The page type (PGMPAGETYPE).
+ * @param   a_uState    The page state (PGM_PAGE_STATE_XXX).
  */
 #define PGM_PAGE_INIT(a_pPage, a_HCPhys, a_idPage, a_uType, a_uState) \
@@ -1553 +1559 @@
  *
  * @returns RAM range TLB index.
- * @param   GCPhys      The guest physical address.
+ * @param   a_GCPhys    The guest physical address.
  */
 #define PGM_RAMRANGE_TLB_IDX(a_GCPhys)      ( ((a_GCPhys) >> 20) & (PGM_RAMRANGE_TLB_ENTRIES - 1) )
@@ -2074 +2080 @@
 /** @typedef PPPGMPAGEMAP
  * Pointer to a page mapper unit pointer for current context. */
-#ifdef IN_RC
+#if defined(IN_RC) && !defined(DOXYGEN_RUNNING)
 // typedef PPGMPAGEGCMAPTLB               PPGMPAGEMAPTLB;
 // typedef PPGMPAGEGCMAPTLBE              PPGMPAGEMAPTLBE;
@@ -3717 +3723 @@
     STAMCOUNTER StatRZSyncPagePDOutOfSync;          /**< RC/R0: The number of time we've encountered an out-of-sync PD in SyncPage. */
     STAMCOUNTER StatRZAccessedPage;                 /**< RC/R0: The number of pages marked not present for accessed bit emulation. */
-    STAMPROFILE StatRZDirtyBitTracking;             /**< RC/R0: Profiling the dirty bit tracking in CheckPageFault().. */
+    STAMPROFILE StatRZDirtyBitTracking;             /**< RC/R0: Profiling the dirty bit tracking in CheckPageFault(). */
     STAMCOUNTER StatRZDirtyPage;                    /**< RC/R0: The number of pages marked read-only for dirty bit tracking. */
     STAMCOUNTER StatRZDirtyPageBig;                 /**< RC/R0: The number of pages marked read-only for dirty bit tracking. */
@@ -3801 +3807 @@
  * Converts a PGMCPU pointer into a VM pointer.
  * @returns Pointer to the VM structure the PGM is part of.
- * @param   pPGM   Pointer to PGMCPU instance data.
+ * @param   pPGM    Pointer to PGMCPU instance data.
  */
 #define PGMCPU2VM(pPGM)         ( (PVM)((char*)(pPGM) - (pPGM)->offVM) )
@@ -3808 +3814 @@
  * Converts a PGMCPU pointer into a PGM pointer.
  * @returns Pointer to the VM structure the PGM is part of.
- * @param   pPGM   Pointer to PGMCPU instance data.
+ * @param   pPGMCpu Pointer to PGMCPU instance data.
  */
 #define PGMCPU2PGM(pPGMCpu)     ( (PPGM)((char *)(pPGMCpu) - (pPGMCpu)->offPGM) )

trunk/src/VBox/VMM/include/TRPMInternal.h

@@ -76 +76 @@
  * Converts a TRPM pointer into a VM pointer.
  * @returns Pointer to the VM structure the TRPM is part of.
- * @param   pTRPM   Pointer to TRPM instance data.
+ * @param   pTRPM       Pointer to TRPM instance data.
  */
 #define TRPM_2_VM(pTRPM)            ( (PVM)((uint8_t *)(pTRPM) - (pTRPM)->offVM) )
@@ -84 +84 @@
  * Converts a TRPM pointer into a TRPMCPU pointer.
  * @returns Pointer to the VM structure the TRPMCPU is part of.
- * @param   pTRPM   Pointer to TRPMCPU instance data.
+ * @param   pTrpmCpu    Pointer to TRPMCPU instance data.
  * @remarks Raw-mode only, not SMP safe.
  */
@@ -109 +109 @@
      * This configuration option is provided for speeding up guest like Solaris
      * that put the IDT on the same page as a whole lot of other data that is
-     * frequently updated. The updates will cause #PFs and have to be interpreted
+     * frequently updated. The updates will cause \#PFs and have to be interpreted
      * by PGMInterpretInstruction which is slow compared to raw execution.
      *
@@ -115 +115 @@
      * there is no problem with dropping the IDT monitoring.
      *
-     * @cfgm    /TRPM/SafeToDropGuestIDTMonitoring   boolean     defaults to false.
+     * @cfgm{/TRPM/SafeToDropGuestIDTMonitoring, boolean, defaults to false.}
      */
     bool                    fSafeToDropGuestIDTMonitoring;
@@ -162 +162 @@
 
     STAMPROFILE             StatTrap0dDisasm;
-    STAMCOUNTER             StatTrap0dRdTsc;    /**< Number of RDTSC #GPs. */
+    STAMCOUNTER             StatTrap0dRdTsc;    /**< Number of RDTSC \#GPs. */
 
 #ifdef VBOX_WITH_STATISTICS
@@ -185 +185 @@
  * Converts a TRPMCPU pointer into a VM pointer.
  * @returns Pointer to the VM structure the TRPMCPU is part of.
- * @param   pTRPM   Pointer to TRPMCPU instance data.
+ * @param   pTrpmCpu    Pointer to TRPMCPU instance data.
  */
 #define TRPMCPU_2_VM(pTrpmCpu)      ( (PVM)((uint8_t *)(pTrpmCpu) - (pTrpmCpu)->offVM) )
@@ -192 +192 @@
  * Converts a TRPMCPU pointer into a VMCPU pointer.
  * @returns Pointer to the VMCPU structure the TRPMCPU is part of.
- * @param   pTRPM   Pointer to TRPMCPU instance data.
+ * @param   pTrpmCpu    Pointer to TRPMCPU instance data.
  */
 #define TRPMCPU_2_VMCPU(pTrpmCpu)   ( (PVMCPU)((uint8_t *)(pTrpmCpu) - (pTrpmCpu)->offVMCpu) )
@@ -240 +240 @@
     RTGCUINT                uPrevVector;
 
-    /** Instruction length for software interrupts and software exceptions (#BP,
-     *  #OF) */
+    /** Instruction length for software interrupts and software exceptions
+     * (\#BP, \#OF) */
     uint8_t                 cbInstr;
 

trunk/src/VBox/VMM/include/VMMInternal.h

@@ -50 +50 @@
  * Ring-0 logging isn't 100% safe yet (thread id reuse / process exit cleanup),
  * so you have to sign up here by adding your defined(DEBUG_<userid>) to the
- * #if, or by adding VBOX_WITH_R0_LOGGING to your LocalConfig.kmk.
+ * \#if, or by adding VBOX_WITH_R0_LOGGING to your LocalConfig.kmk.
  */
 #if defined(DEBUG_sandervl) || defined(DEBUG_frank) || defined(DEBUG_ramshankar) || defined(DOXYGEN_RUNNING)
@@ -514 +514 @@
     /** Switching testing and profiling stub. */
     VMMRC_DO_TESTCASE_NOP,
-    /** Testcase for checking interrupt masking.. */
+    /** Testcase for checking interrupt masking. */
     VMMRC_DO_TESTCASE_INTERRUPT_MASKING,
     /** Switching testing and profiling stub. */
@@ -585 +585 @@
  * @param   pfn         The function to be called when not resuming..
  * @param   pVM         The argument of that function.
+ * @param   pVCpu       The VCPU of the calling EMT.
  */
 DECLASM(int)    vmmR0CallRing3SetJmp(PVMMR0JMPBUF pJmpBuf, PFNVMMR0SETJMP pfn, PVM pVM, PVMCPU pVCpu);