Changeset 41777 in vbox for trunk/src/VBox/VMM/VMMR0

Timestamp:

Jun 16, 2012 6:49:15 PM (13 years ago)

Author:

vboxsync

Message:

Doxygen.

File:

• trunk/src/VBox/VMM/VMMR0/GVMMR0.cpp (modified) (17 diffs)

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

@@ -966 +966 @@
  *
  * @returns VBox status code.
- * @param   pVM         Pointer to the shared VM structure.
+ * @param   pVM         Pointer to the VM.
  */
 GVMMR0DECL(int) GVMMR0InitVM(PVM pVM)
@@ -1006 +1006 @@
  * of the VM.
  *
- * @param   pVM         Pointer to the shared VM structure.
+ * @param   pVM         Pointer to the VM.
  * @thread  EMT(0)
  */
@@ -1026 +1026 @@
  *
  * @returns true if termination hasn't been done already, false if it has.
- * @param   pVM         Pointer to the shared VM structure.
+ * @param   pVM         Pointer to the VM.
  * @param   pGVM        Pointer to the global VM structure. Optional.
  * @thread  EMT(0)
@@ -1540 +1540 @@
  * Lookup a VM by its global handle.
  *
- * @returns The VM handle on success, NULL on failure.
+ * @returns Pointer to the VM on success, NULL on failure.
  * @param   hGVM    The global VM handle. Asserts on bad handle.
  */
@@ -1557 +1557 @@
  * call may or not be an EMT thread.
  *
- * @returns The VM handle on success, NULL on failure.
+ * @returns Pointer to the VM on success, NULL on failure.
  * @param   hEMT    The native thread handle of the EMT.
  *                  NIL_RTNATIVETHREAD means the current thread
@@ -1755 +1755 @@
  * @returns VINF_SUCCESS normal wakeup (timeout or kicked by other thread).
  *          VERR_INTERRUPTED if a signal was scheduled for the thread.
- * @param   pVM                 Pointer to the shared VM structure.
+ * @param   pVM                 Pointer to the VM.
  * @param   idCpu               The Virtual CPU ID of the calling EMT.
  * @param   u64ExpireGipTime    The time for the sleep to expire expressed as GIP time.
@@ -1890 +1890 @@
  * @retval  VINF_GVM_NOT_BLOCKED if the EMT wasn't blocked.
  *
- * @param   pVM                 Pointer to the shared VM structure.
+ * @param   pVM                 Pointer to the VM.
  * @param   idCpu               The Virtual CPU ID of the EMT to wake up.
  * @param   fTakeUsedLock       Take the used lock or not
@@ -1944 +1944 @@
  * @retval  VINF_GVM_NOT_BLOCKED if the EMT wasn't blocked.
  *
- * @param   pVM                 Pointer to the shared VM structure.
+ * @param   pVM                 Pointer to the VM.
  * @param   idCpu               The Virtual CPU ID of the EMT to wake up.
  * @thread  Any but EMT.
@@ -1962 +1962 @@
  *
  * @param   pGVM                The global (ring-0) VM structure.
- * @param   pVCpu               The Virtual CPU handle.
+ * @param   pVCpu               Pointer to the VMCPU.
  */
 DECLINLINE(int) gvmmR0SchedPokeOne(PGVM pGVM, PVMCPU pVCpu)
@@ -1988 +1988 @@
  * @retval  VINF_GVM_NOT_BUSY_IN_GC if the EMT wasn't busy in GC.
  *
- * @param   pVM                 Pointer to the shared VM structure.
+ * @param   pVM                 Pointer to the VM.
  * @param   idCpu               The ID of the virtual CPU to poke.
  * @param   fTakeUsedLock       Take the used lock or not
@@ -2026 +2026 @@
  * @retval  VINF_GVM_NOT_BUSY_IN_GC if the EMT wasn't busy in GC.
  *
- * @param   pVM                 Pointer to the shared VM structure.
+ * @param   pVM                 Pointer to the VM.
  * @param   idCpu               The ID of the virtual CPU to poke.
  */
@@ -2040 +2040 @@
  * @returns VBox status code, no informational stuff.
  *
- * @param   pVM                 Pointer to the shared VM structure.
+ * @param   pVM                 Pointer to the VM.
  * @param   pSleepSet           The set of sleepers to wake up.
  * @param   pPokeSet            The set of CPUs to poke.
@@ -2086 +2086 @@
  *
  * @returns see GVMMR0SchedWakeUpAndPokeCpus.
- * @param   pVM             Pointer to the shared VM structure.
- * @param   pReq            The request packet.
+ * @param   pVM             Pointer to the VM.
+ * @param   pReq            Pointer to the request packet.
  */
 GVMMR0DECL(int) GVMMR0SchedWakeUpAndPokeCpusReq(PVM pVM, PGVMMSCHEDWAKEUPANDPOKECPUSREQ pReq)
@@ -2110 +2110 @@
  * @returns VINF_SUCCESS if not yielded.
  *          VINF_GVM_YIELDED if an attempt to switch to a different VM task was made.
- * @param   pVM                 Pointer to the shared VM structure.
+ * @param   pVM                 Pointer to the VM.
  * @param   idCpu               The Virtual CPU ID of the calling EMT.
  * @param   u64ExpireGipTime    The time for the sleep to expire expressed as GIP time.
@@ -2240 +2240 @@
  * The caller must check that the host can do high resolution timers.
  *
- * @param   pVM         The VM handle.
+ * @param   pVM         Pointer to the VM.
  * @param   idHostCpu   The current host CPU id.
  * @param   uHz         The desired frequency.
@@ -2437 +2437 @@
  *
  * @returns see GVMMR0QueryStatistics.
- * @param   pVM             Pointer to the shared VM structure. Optional.
- * @param   pReq            The request packet.
+ * @param   pVM             Pointer to the VM. Optional.
+ * @param   pReq            Pointer to the request packet.
  */
 GVMMR0DECL(int) GVMMR0QueryStatisticsReq(PVM pVM, PGVMMQUERYSTATISTICSSREQ pReq)
@@ -2552 +2552 @@
  *
  * @returns see GVMMR0ResetStatistics.
- * @param   pVM             Pointer to the shared VM structure. Optional.
- * @param   pReq            The request packet.
+ * @param   pVM             Pointer to the VM. Optional.
+ * @param   pReq            Pointer to the request packet.
  */
 GVMMR0DECL(int) GVMMR0ResetStatisticsReq(PVM pVM, PGVMMRESETSTATISTICSSREQ pReq)