Changeset 65168 in vbox

Timestamp:

Jan 5, 2017 8:14:10 PM (8 years ago)

Author:

vboxsync

Message:

doxygen fixes

Location:

trunk

Files:

• Doxyfile.Core (modified) (1 diff)
• Makefile.kmk (modified) (1 diff)
• src/VBox/HostServices/SharedFolders/vbsf.cpp (modified) (3 diffs)
• src/VBox/VMM/VMMAll/CPUMAllRegs.cpp (modified) (1 diff)
• src/VBox/VMM/VMMAll/IEMAllCImpl.cpp.h (modified) (1 diff)
• src/VBox/VMM/VMMAll/TRPMAll.cpp (modified) (1 diff)

trunk/Doxyfile.Core

@@ -564 +564 @@
     DECLSPEC_HIDDEN= \
     VMSVGA3DCOCOA_DECL(type)=type \
-    VBOX_LISTENER_DECLARE(a)=
+    VBOX_LISTENER_DECLARE(a)= \
+    VBOX_WITH_RAW_MODE_NOT_R0
 
 # BS3Kit

trunk/Makefile.kmk

@@ -917 +917 @@
                -e '/warning. Unexpected tag .dd. found/d' \
                -e '/warning. Unsupported xml.html tag .globalScope. found/d' \
-               -e '/\/include\/VBox\/com\/EventQueue\.h.* warning/b ignore' \
-               -e '/\/include\/VBox\/com\/NativeEventQueue\.h.* warning/b ignore' \
                -e '/\/src\/VBox\/Main\/.* warning/b ignore' \
                -e '/\/src\/VBox\/Additions\/WINNT\/VBoxTray\/VBoxDispIf\.h.* warning/b ignore' \
                -e '/\/src\/VBox\/Additions\/common\/crOpenGL\/.* warning/b ignore' \
                -e '/\/src\/VBox\/Additions\/x11\/VBoxClient\/seamless-x11\.h.* warning/b ignore' \
-               -e '/\/src\/VBox\/HostServices\/SharedFolders\/.* warning/b ignore' \
                -e '/\/src\/VBox\/HostDrivers\/Support\/win\/SUPR3HardenedMain-win\.cpp.* warning/b ignore' \
                -e '/\/src\/VBox\/ValidationKit\/.* warning/b ignore' \

trunk/src/VBox/HostServices/SharedFolders/vbsf.cpp

@@ -379 +379 @@
  * @param  pClient               Data structure describing the client accessing the shared folder
  * @param  pszPath               Path to the file or folder on the host.
- * @param  pParms->CreateFlags   Creation or open parameters, see include/VBox/shflsvc.h
- * @param  pParms->Info          When a new file is created this specifies the initial parameters.
+ * @param  pParms @a CreateFlags Creation or open parameters, see include/VBox/shflsvc.h
+ * @param  pParms @a Info        When a new file is created this specifies the initial parameters.
  *                               When a file is created or overwritten, it also specifies the
  *                               initial size.
- * @retval pParms->Result        Shared folder status code, see include/VBox/shflsvc.h
- * @retval pParms->Handle        On success the (shared folder) handle of the file opened or
+ * @retval pParms @a Resulte     Shared folder status code, see include/VBox/shflsvc.h
+ * @retval pParms @a Handle      On success the (shared folder) handle of the file opened or
  *                               created
- * @retval pParms->Info          On success the parameters of the file opened or created
+ * @retval pParms @a Info        On success the parameters of the file opened or created
  */
 static int vbsfOpenFile(SHFLCLIENTDATA *pClient, const char *pszPath, SHFLCREATEPARMS *pParms)
@@ -552 +552 @@
  *
  * @returns IPRT status code
+ * @param  pClient               Data structure describing the client accessing the shared folder
  * @param  pszPath               Path to the file or folder on the host.
- * @param  pParms->CreateFlags   Creation or open parameters, see include/VBox/shflsvc.h
- * @retval pParms->Result        Shared folder status code, see include/VBox/shflsvc.h
- * @retval pParms->Handle        On success the (shared folder) handle of the folder opened or
+ * @param  pParms @a CreateFlags Creation or open parameters, see include/VBox/shflsvc.h
+ * @retval pParms @a Result      Shared folder status code, see include/VBox/shflsvc.h
+ * @retval pParms @a Handle      On success the (shared folder) handle of the folder opened or
  *                               created
- * @retval pParms->Info          On success the parameters of the folder opened or created
+ * @retval pParms @a Info        On success the parameters of the folder opened or created
  *
  * @note folders are created with fMode = 0777
@@ -773 +774 @@
  * @param   cbPath         Presumably the length of the path in pPath.  Actually
  *                         ignored, as pPath contains a length parameter.
- * @param   pParms->Info   If a new file is created or an old one overwritten, set
+ * @param   pParms @a Info If a new file is created or an old one overwritten, set
  *                         these attributes
- * @retval  pParms->Result Shared folder result code, see include/VBox/shflsvc.h
- * @retval  pParms->Handle Shared folder handle to the newly opened file
- * @retval  pParms->Info   Attributes of the file or folder opened
+ * @retval  pParms @a Result Shared folder result code, see include/VBox/shflsvc.h
+ * @retval  pParms @a Handle Shared folder handle to the newly opened file
+ * @retval  pParms @a Info Attributes of the file or folder opened
  *
  * @note This function returns success if a "non-exceptional" error occurred,

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

@@ -153 +153 @@
  * Loads a the hidden parts of a selector register.
  *
- * @param   pVCpu               The cross context virtual CPU structure of the calling EMT.
+ * @param   pVCpu       The cross context virtual CPU structure of the calling EMT.
+ * @param   pSReg       The selector register to lazily load hidden parts of.
  */
 VMM_INT_DECL(void) CPUMGuestLazyLoadHiddenSelectorReg(PVMCPU pVCpu, PCPUMSELREG pSReg)

trunk/src/VBox/VMM/VMMAll/IEMAllCImpl.cpp.h

@@ -191 +191 @@
  * Helper used by iret.
  *
+ * @param   pVCpu               The cross context virtual CPU structure of the calling thread.
  * @param   uCpl                The new CPL.
  * @param   pSReg               Pointer to the segment register.

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

@@ -457 +457 @@
  *  or does not return at all (when the trap is actually forwarded)
  *
- * @param   pVM         The cross context VM structure.
+ * @param   pVCpu       The cross context virtual CPU structure.
  * @param   pRegFrame   Pointer to the register frame for the trap.
  * @param   iGate       Trap or interrupt gate number