Changeset 99739 in vbox for trunk/src/VBox/VMM/VMMAll

Timestamp:

May 11, 2023 1:01:08 AM (19 months ago)

Author:

vboxsync

Message:

*: doxygen corrections (mostly about removing @returns from functions returning void).

Location:

trunk/src/VBox/VMM/VMMAll

Files:

• APICAll.cpp (modified) (1 diff)
• CPUMAllRegs.cpp (modified) (1 diff)
• DBGFAllTracer.cpp (modified) (2 diffs)
• HMAll.cpp (modified) (1 diff)
• IEMAll.cpp (modified) (2 diffs)
• PGMAll.cpp (modified) (1 diff)
• PGMAllHandler.cpp (modified) (1 diff)
• PGMAllPhys.cpp (modified) (1 diff)

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

@@ -3429 +3429 @@
  * Posts an interrupt to a target APIC, Hyper-V interface.
  *
- * @returns true if the interrupt was accepted, false otherwise.
  * @param   pVCpu               The cross context virtual CPU structure.
  * @param   uVector             The vector of the interrupt to be posted.

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

@@ -1728 +1728 @@
  * Mark the guest's debug state as inactive.
  *
- * @returns boolean
  * @param   pVCpu       The cross context virtual CPU structure of the calling EMT.
  * @todo    This API doesn't make sense any more.

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

@@ -190 +190 @@
  * Copies the given MMIO value into the event descriptor based on the given size.
  *
- * @returns nothing.
  * @param   pEvtMmio                Pointer to the MMIO event descriptor to fill.
  * @param   pvVal                   The value to copy.
@@ -220 +219 @@
  * Copies the given I/O port value into the event descriptor based on the given size.
  *
- * @returns nothing.
  * @param   pEvtIoPort              Pointer to the I/O port read/write event descriptor to fill.
  * @param   pvVal                   The value to copy.

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

@@ -389 +389 @@
  * Queues a guest page for invalidation.
  *
- * @returns VBox status code.
  * @param   pVCpu       The cross context virtual CPU structure.
  * @param   GCVirt      Page to invalidate.

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

@@ -567 +567 @@
  * This is called internally as well as by PGM when moving GC mappings.
  *
- * @returns
  * @param   pVCpu       The cross context virtual CPU structure of the calling
  *                      thread.
@@ -6776 +6775 @@
  * The caller shall only call this after checking cActiveMappings.
  *
- * @returns Strict VBox status code to pass up.
  * @param   pVCpu       The cross context virtual CPU structure of the calling thread.
  */

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

@@ -3858 +3858 @@
  * Release the PGM lock.
  *
- * @returns VBox status code
  * @param   pVM         The cross context VM structure.
  */

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

@@ -987 +987 @@
  * Resets ram range flags.
  *
- * @returns VBox status code.
- * @retval  VINF_SUCCESS when shadow PTs was successfully updated.
  * @param   pVM     The cross context VM structure.
  * @param   pCur    The physical handler.

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

@@ -1210 +1210 @@
 /**
  * Deal with a write monitored page.
- *
- * @returns VBox strict status code.
  *
  * @param   pVM         The cross context VM structure.