Changeset 56045 in vbox for trunk/src

Timestamp:

May 22, 2015 9:05:29 PM (10 years ago)

Author:

vboxsync

Message:

PATMRC.cpp: docs

File:

• trunk/src/VBox/VMM/VMMRC/PATMRC.cpp (modified) (1 diff)

trunk/src/VBox/VMM/VMMRC/PATMRC.cpp

@@ -46 +46 @@
 
 /**
- * \#PF Virtual Handler callback for Guest access a page monitored by PATM
- *
- * @returns VBox status code (appropriate for trap handling and GC return).
- * @param   pVM         Pointer to the VM.
- * @param   pVCpu       Pointer to the cross context CPU context for the
- *                      calling EMT.
- * @param   uErrorCode  CPU Error code.
- * @param   pRegFrame   Trap register frame.
- * @param   pvFault     The fault address (cr2).
- * @param   pvRange     The base address of the handled virtual range.
- * @param   offRange    The offset of the access into this range.
- *                      (If it's a EIP range this is the EIP, if not it's pvFault.)
- * @param   pvUser      The physical address of the guest page being monitored.
+ * @callback_method_impl{FNPGMRZPHYSPFHANDLER,
+ *      PATM all access handler callback.}
+ *
+ * @remarks The @a pvUser argument is the base address of the page being
+ *          monitored.
  */
 DECLEXPORT(VBOXSTRICTRC) patmRCVirtPagePfHandler(PVM pVM, PVMCPU pVCpu, RTGCUINT uErrorCode, PCPUMCTXCORE pRegFrame,