Changeset 48557 in vbox for trunk/include/VBox/vmm

Timestamp:

Sep 19, 2013 5:58:32 PM (12 years ago)

Author:

vboxsync

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

89108

Message:

vm.h: Doxygen.

File:

• trunk/include/VBox/vmm/vm.h (modified) (12 diffs)

trunk/include/VBox/vmm/vm.h

@@ -494 +494 @@
  * Sets a force action flag.
  *
- * @param   pVM     VM Handle.
+ * @param   pVM     Pointer to the VM.
  * @param   fFlag   The flag to set.
  */
@@ -509 +509 @@
  * Sets a force action flag for the given VCPU.
  *
- * @param   pVCpu     VMCPU Handle.
+ * @param   pVCpu   Pointer to the VMCPU.
  * @param   fFlag   The flag to set.
  */
@@ -517 +517 @@
  * Clears a force action flag.
  *
- * @param   pVM     VM Handle.
+ * @param   pVM     Pointer to the VM.
  * @param   fFlag   The flag to clear.
  */
@@ -532 +532 @@
  * Clears a force action flag for the given VCPU.
  *
- * @param   pVCpu     VMCPU Handle.
+ * @param   pVCpu   Pointer to the VMCPU.
  * @param   fFlag   The flag to clear.
  */
@@ -540 +540 @@
  * Checks if a force action flag is set.
  *
- * @param   pVM     VM Handle.
+ * @param   pVM     Pointer to the VM.
  * @param   fFlag   The flag to check.
  */
@@ -548 +548 @@
  * Checks if a force action flag is set for the given VCPU.
  *
- * @param   pVCpu   VMCPU Handle.
+ * @param   pVCpu   Pointer to the VMCPU.
  * @param   fFlag   The flag to check.
  */
@@ -556 +556 @@
  * Checks if one or more force action in the specified set is pending.
  *
- * @param   pVM     VM Handle.
+ * @param   pVM     Pointer to the VM.
  * @param   fFlags  The flags to check for.
  */
@@ -566 +566 @@
  * @returns true if the bit was set.
  * @returns false if the bit was clear.
- * @param   pVM     VM Handle.
+ * @param   pVM     Pointer to the VM.
  * @param   iBit    Bit position to check and clear
  */
@@ -576 +576 @@
  * @returns true if the bit was set.
  * @returns false if the bit was clear.
- * @param   pVCpu   VMCPU Handle.
+ * @param   pVCpu   Pointer to the VMCPU.
  * @param   iBit    Bit position to check and clear
  */
@@ -584 +584 @@
  * Checks if one or more force action in the specified set is pending for the given VCPU.
  *
- * @param   pVCpu   VMCPU Handle.
+ * @param   pVCpu   Pointer to the VMCPU.
  * @param   fFlags  The flags to check for.
  */
@@ -593 +593 @@
  * or more other ones are not.
  *
- * @param   pVM     VM Handle.
+ * @param   pVM     Pointer to the VM.
  * @param   fFlags  The flags to check for.
  * @param   fExcpt  The flags that should not be set.
@@ -603 +603 @@
  * VCPU while one or more other ones are not.
  *
- * @param   pVCpu     VMCPU Handle.
+ * @param   pVCpu   Pointer to the VMCPU.
  * @param   fFlags  The flags to check for.
  * @param   fExcpt  The flags that should not be set.