Changeset 58339 in vbox for trunk/src/VBox

Timestamp:

Oct 20, 2015 1:58:22 PM (9 years ago)

Author:

vboxsync

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

103539

Message:

Support/win: doxygen fixes.

Location:

trunk/src/VBox/HostDrivers/Support/win

Files:

• SUPHardenedVerifyImage-win.cpp (modified) (2 diffs)
• SUPHardenedVerifyProcess-win.cpp (modified) (6 diffs)
• SUPR3HardenedMain-win.cpp (modified) (2 diffs)
• SUPR3HardenedMainImports-win.cpp (modified) (1 diff)

trunk/src/VBox/HostDrivers/Support/win/SUPHardenedVerifyImage-win.cpp

@@ -579 +579 @@
  *
  * @returns true if starts with given string, false if not.
- * @param   pwsz                The UTF-16 path string.
- * @param   pszPrefix           The ascii prefix string.
+ * @param   pwszLeft            The UTF-16 path string.
+ * @param   pszRight            The ascii prefix string.
  */
 static bool supHardViUtf16PathStartsWithAscii(PCRTUTF16 pwszLeft, const char *pszRight)
@@ -2621 +2621 @@
  * supR3HardenedScreenImage.
  *
- * @returns IPRT status code.
+ * @returns IPRT status code, modified @a rc.
  * @param   hFile               Handle of the file to verify.
  * @param   pwszName            Full NT path to the DLL in question, used for
  *                              dealing with unsigned system dlls as well as for
  *                              error/logging.
+ * @param   fFlags              SUPHNTVI_F_XXX.
+ * @param   rc                  The current status code.
  * @param   pfWinVerifyTrust    Where to return whether WinVerifyTrust was
  *                              actually used.

trunk/src/VBox/HostDrivers/Support/win/SUPHardenedVerifyProcess-win.cpp

@@ -243 +243 @@
 
 #ifdef IN_RING3
-/** The number of valid entries in the loader cache.. */
+/** The number of valid entries in the loader cache. */
 static uint32_t                 g_cSupNtVpLdrCacheEntries = 0;
 /** The loader cache entries. */
@@ -256 +256 @@
  * @param   pErrInfo            Pointer to the extended error info structure.
  *                              Can be NULL.
- * @param   pszErr              Where to return error details.
- * @param   cbErr               Size of the buffer @a pszErr points to.
  * @param   rc                  The status to return.
  * @param   pszMsg              The format string for the message.
@@ -284 +282 @@
  * @returns @a rc.
  * @param   pThis               The process validator instance.
- * @param   pszErr              Where to return error details.
- * @param   cbErr               Size of the buffer @a pszErr points to.
  * @param   rc                  The status to return.
  * @param   pszMsg              The format string for the message.
@@ -1011 +1007 @@
  *                              space scan.
  * @param   hProcess            Handle to the process.
- * @param   hFile               Handle to the image file.
  */
 static int supHardNtVpVerifyImage(PSUPHNTVPSTATE pThis, PSUPHNTVPIMAGE pImage, HANDLE hProcess)
@@ -1135 +1130 @@
  * @param   pUniStr     The path to fix up. MaximumLength is the max buffer
  *                      length.
+ * @param   fPathOnly   Whether to only process the path and leave the filename
+ *                      as passed in.
  */
 DECLHIDDEN(void) supHardNtVpFix8dot3Path(PUNICODE_STRING pUniStr, bool fPathOnly)
@@ -1974 +1971 @@
  * @param   pEntry              The loader cache entry.
  * @param   pwszName            The filename to use in error messages.
- * @param   pErRInfo            Where to return extened error information.
+ * @param   pErrInfo            Where to return extened error information.
  */
 DECLHIDDEN(int) supHardNtLdrCacheEntryVerify(PSUPHNTLDRCACHEENTRY pEntry, PCRTUTF16 pwszName, PRTERRINFO pErrInfo)

trunk/src/VBox/HostDrivers/Support/win/SUPR3HardenedMain-win.cpp

@@ -2958 +2958 @@
  *
  * @returns Pointer to a command line string (heap).
- * @param   pUniStr         Unicode string structure to initialize to the
+ * @param   pString         Unicode string structure to initialize to the
  *                          command line. Optional.
  * @param   iWhich          Which respawn we're to check for, 1 being the first
@@ -3749 +3749 @@
  * Gather child data.
  *
- * @param   This                The child process data structure.
+ * @param   pThis               The child process data structure.
  */
 static void supR3HardNtChildGatherData(PSUPR3HARDNTCHILD pThis)

trunk/src/VBox/HostDrivers/Support/win/SUPR3HardenedMainImports-win.cpp

@@ -636 +636 @@
  * We must not permanently modify any global data here.
  *
- * @param   uNtDllAddr          The address of the NTDLL.
+ * @param   uNtDllAddr                  The address of the NTDLL.
+ * @param   ppfnNtWaitForSingleObject   Where to store the NtWaitForSingleObject
+ *                                      address.
+ * @param   ppfnNtSetEvent              Where to store the NtSetEvent address.
  */
 DECLHIDDEN(void) supR3HardenedWinGetVeryEarlyImports(uintptr_t uNtDllAddr,