Changeset 41836 in vbox

Timestamp:

Jun 19, 2012 4:20:52 PM (12 years ago)

Author:

vboxsync

Message:

Doxygen.

Location:

trunk/src/VBox/VMM

Files:

• VMMAll/CPUMAllRegs.cpp (modified) (3 diffs)
• VMMAll/PGMAllBth.h (modified) (3 diffs)
• VMMAll/TMAllCpu.cpp (modified) (3 diffs)
• VMMR0/HWACCMR0.cpp (modified) (1 diff)
• VMMR0/PGMR0.cpp (modified) (1 diff)
• VMMR0/PGMR0SharedPage.cpp (modified) (1 diff)
• VMMR0/VMMR0.cpp (modified) (2 diffs)
• VMMR3/EMHwaccm.cpp (modified) (1 diff)
• VMMR3/PATM.cpp (modified) (3 diffs)
• VMMR3/PGMPhys.cpp (modified) (1 diff)
• VMMRZ/PGMRZDynMap.cpp (modified) (1 diff)
• include/VMMInternal.h (modified) (1 diff)

trunk/src/VBox/VMM/VMMAll/CPUMAllRegs.cpp

@@ -734 +734 @@
  *
  * The caller is responsible for checking privilege if the call is the result
- * of a RDMSR instruction.  We'll do the rest.
+ * of a RDMSR instruction. We'll do the rest.
  *
  * @retval  VINF_SUCCESS on success.
  * @retval  VERR_CPUM_RAISE_GP_0 on failure (invalid MSR), the caller is
  *          expected to take the appropriate actions. @a *puValue is set to 0.
- * @param   pVCpu               The virtual CPU to operate on.
+ * @param   pVCpu               Pointer to the VMCPU.
  * @param   idMsr               The MSR.
- * @param   puValue             Where to return the value..
+ * @param   puValue             Where to return the value.
  *
  * @remarks This will always return the right values, even when we're in the
@@ -971 +971 @@
  *
  * The caller is responsible for checking privilege if the call is the result
- * of a WRMSR instruction.  We'll do the rest.
+ * of a WRMSR instruction. We'll do the rest.
  *
  * @retval  VINF_SUCCESS on success.
@@ -977 +977 @@
  *          appropriate actions.
  *
- * @param   pVCpu       The virtual CPU to operate on.
+ * @param   pVCpu       Pointer to the VMCPU.
  * @param   idMsr       The MSR id.
  * @param   uValue      The value to set.
  *
  * @remarks Everyone changing MSR values, including the recompiler, shall do it
- *          by calling this method.  This makes sure we have current values and
+ *          by calling this method. This makes sure we have current values and
  *          that we trigger all the right actions when something changes.
  */

trunk/src/VBox/VMM/VMMAll/PGMAllBth.h

@@ -2286 +2286 @@
  *
  * @returns VINF_EM_RAW_GUEST_TRAP.
- * @param   pVCpu           The virtual CPU to operate on.
+ * @param   pVCpu           Pointer to the VMCPU.
  * @param   uErr            The error code of the shadow fault.  Corrections to
  *                          TRPM's copy will be made if necessary.
@@ -2310 +2310 @@
  *
  * @returns VINF_EM_RAW_GUEST_TRAP.
- * @param   pVCpu           The virtual CPU to operate on.
+ * @param   pVCpu           Pointer to the VMCPU.
  * @param   uErr            The error code of the shadow fault.  Corrections to
  *                          TRPM's copy will be made if necessary.
@@ -2331 +2331 @@
  *
  * @returns VINF_EM_RAW_GUEST_TRAP.
- * @param   pVCpu           The virtual CPU to operate on.
+ * @param   pVCpu           Pointer to the VMCPU.
  * @param   uErr            The error code of the shadow fault.  Corrections to
  *                          TRPM's copy will be made if necessary.

trunk/src/VBox/VMM/VMMAll/TMAllCpu.cpp

@@ -364 +364 @@
  * @returns VBox status code.
  * @param   pVM         Pointer to the VM.
- * @param   pVCpu       The virtual CPU to operate on.
+ * @param   pVCpu       Pointer to the VMCPU.
  * @param   u64Tick     The new timestamp value.
  *
@@ -394 +394 @@
  *
  * @returns VBox status code.
- * @param   pVCpu               The virtual CPU to operate on.
+ * @param   pVCpu               Pointer to the VMCPU.
  * @param   u64LastSeenTick     The last seen timestamp value.
  *
@@ -413 +413 @@
  *
  * @returns last seen TSC
- * @param   pVCpu               The virtual CPU to operate on.
+ * @param   pVCpu               Pointer to the VMCPU.
  *
  * @thread  EMT which TSC is to be set.

trunk/src/VBox/VMM/VMMR0/HWACCMR0.cpp

@@ -1507 +1507 @@
  * @returns VBox status code.
  * @param   pVM         Pointer to the VM.
- * @param   pVCpu       VMCPUD id.
+ * @param   pVCpu       Pointer to the VMCPU.
  *
  * @remarks Called with preemption disabled and after first having called

trunk/src/VBox/VMM/VMMR0/PGMR0.cpp

@@ -504 +504 @@
  * @returns VBox status code (appropriate for trap handling and GC return).
  * @param   pVM                 Pointer to the VM.
- * @param   pVCpu               The current CPU.
+ * @param   pVCpu               Pointer to the VMCPU.
  * @param   enmShwPagingMode    Paging mode for the nested page tables.
  * @param   pRegFrame           Trap register frame.

trunk/src/VBox/VMM/VMMR0/PGMR0SharedPage.cpp

@@ -42 +42 @@
  * @param   pGVM                Pointer to the GVM instance data.
  * @param   idCpu               The ID of the calling virtual CPU.
- * @param   pModule             Global module description
+ * @param   pModule             Global module description.
  * @param   paRegionsGCPtrs     Array parallel to pModules->aRegions with the
  *                              addresses of the regions in the calling

trunk/src/VBox/VMM/VMMR0/VMMR0.cpp

@@ -244 +244 @@
  * @returns VBox status code.
  *
- * @param   pVM         The VM instance in question.
+ * @param   pVM         Pointer to the VM.
  * @param   uSvnRev     The SVN revision of the ring-3 part.
  * @thread  EMT.
@@ -371 +371 @@
  * @returns VBox status code.
  *
- * @param   pVM         The VM instance in question.
+ * @param   pVM         Pointer to the VM.
  * @param   pGVM        Pointer to the global VM structure. Optional.
  * @thread  EMT or session clean up thread.

trunk/src/VBox/VMM/VMMR3/EMHwaccm.cpp

@@ -390 +390 @@
  * @param   pVM         Pointer to the VM.
  * @param   pVCpu       Pointer to the VMCPU.
- * @param   pCtx        The guest CPUM register context.
+ * @param   pCtx        Pointer to the guest CPU context.
  */
 static int emR3HwaccmForcedActions(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx)

trunk/src/VBox/VMM/VMMR3/PATM.cpp

@@ -3493 +3493 @@
  * @returns VBox status code.
  * @param   pVM         Pointer to the VM.
- * @param   pCtx        Guest context
+ * @param   pCtx        Pointer to the guest CPU context.
  *
  */
@@ -6051 +6051 @@
  *
  * @returns VBox status code.
- * @param   pVM         Pointer to the VM.
- * @param   pCtx        CPU context
- * @param   pPatch      Patch record
- * @param   pPatchToGuestRec    Patch to guest address record
- * @param   pEip        GC pointer of trapping instruction
+ * @param   pVM                 Pointer to the VM.
+ * @param   pCtx                Pointer to the guest CPU context.
+ * @param   pPatch              Patch record.
+ * @param   pPatchToGuestRec    Patch to guest address record.
+ * @param   pEip                GC pointer of trapping instruction.
  */
 static int patmR3HandleDirtyInstr(PVM pVM, PCPUMCTX pCtx, PPATMPATCHREC pPatch, PRECPATCHTOGUEST pPatchToGuestRec, RTRCPTR pEip)
@@ -6279 +6279 @@
  * @returns VBox status code.
  * @param   pVM         Pointer to the VM.
- * @param   pCtx        CPU context
- * @param   pEip        GC pointer of trapping instruction
- * @param   ppNewEip    GC pointer to new instruction
+ * @param   pCtx        Pointer to the guest CPU context.
+ * @param   pEip        GC pointer of trapping instruction.
+ * @param   ppNewEip    GC pointer to new instruction.
  */
 VMMR3DECL(int) PATMR3HandleTrap(PVM pVM, PCPUMCTX pCtx, RTRCPTR pEip, RTGCPTR *ppNewEip)

trunk/src/VBox/VMM/VMMR3/PGMPhys.cpp

@@ -3704 +3704 @@
  * Sets the Address Gate 20 state.
  *
- * @param   pVCpu       The VCPU to operate on.
+ * @param   pVCpu       Pointer to the VMCPU.
  * @param   fEnable     True if the gate should be enabled.
  *                      False if the gate should be disabled.

trunk/src/VBox/VMM/VMMRZ/PGMRZDynMap.cpp

@@ -339 +339 @@
  *
  * @returns VINF_SUCCESS on success, VERR_PGM_DYNMAP_IPE on failure.
- * @param   pVM         The VM in question.
+ * @param   pVM         Pointer to the VM.
  */
 static int pgmRZDynMapInitAutoSetsForVM(PVM pVM)

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

@@ -530 +530 @@
  *
  * @returns return code from VMMGCEntry().
- * @param   pVM     The VM in question.
+ * @param   pVM     Pointer to the VM.
  * @param   uArg    See VMMGCEntry().
  * @internal