Changeset 57978 in vbox

Timestamp:

Sep 30, 2015 7:39:30 PM (9 years ago)

Author:

vboxsync

Message:

IPRT: Doxygen warning fixes (last ones, hopefully).

Location:

trunk

Files:

• include/iprt/critsect.h (modified) (2 diffs)
• include/iprt/list.h (modified) (4 diffs)
• include/iprt/mem.h (modified) (1 diff)
• include/iprt/uint128.h (modified) (2 diffs)
• src/VBox/Runtime/common/dbg/dbgmodcodeview.cpp (modified) (3 diffs)
• src/VBox/Runtime/common/dbg/dbgmoddeferred.cpp (modified) (1 diff)
• src/VBox/Runtime/common/dbg/dbgmoddwarf.cpp (modified) (3 diffs)
• src/VBox/Runtime/common/path/RTPathGlob.cpp (modified) (4 diffs)
• src/VBox/Runtime/r0drv/nt/initterm-r0drv-nt.cpp (modified) (1 diff)
• src/VBox/Runtime/r0drv/nt/mp-r0drv-nt.cpp (modified) (1 diff)
• src/VBox/Runtime/r0drv/nt/ntBldSymDb.cpp (modified) (3 diffs)
• src/VBox/Runtime/r3/nt/pathint-nt.cpp (modified) (1 diff)
• src/VBox/Runtime/r3/socket.cpp (modified) (1 diff)
• src/VBox/Runtime/r3/win/process-win.cpp (modified) (2 diffs)

trunk/include/iprt/critsect.h

@@ -646 +646 @@
  * Checks the caller is the exclusive (write) owner of the critical section.
  *
- * @retval  @c true if owner.
- * @retval  @c false if not owner.
+ * @retval  true if owner.
+ * @retval  false if not owner.
  * @param   pThis           Pointer to the read/write critical section.
  */
@@ -705 +705 @@
  * Checks if a critical section is initialized or not.
  *
- * @retval  @c true if initialized.
- * @retval  @c false if not initialized.
+ * @retval  true if initialized.
+ * @retval  false if not initialized.
  * @param   pThis           Pointer to the read/write critical section.
  */

trunk/include/iprt/list.h

@@ -153 +153 @@
  * Checks if a node is the last element in the list.
  *
- * @retval  @c true if the node is the last element in the list.
- * @retval  @c false otherwise
+ * @retval  true if the node is the last element in the list.
+ * @retval  false otherwise
  *
  * @param   pList               The list.
@@ -164 +164 @@
  * Checks if a node is the first element in the list.
  *
- * @retval  @c true if the node is the first element in the list.
- * @retval  @c false otherwise.
+ * @retval  true if the node is the first element in the list.
+ * @retval  false otherwise.
  *
  * @param   pList               The list.
@@ -175 +175 @@
  * Checks if a type converted node is actually the dummy element (@a pList).
  *
- * @retval  @c true if the node is the dummy element in the list.
- * @retval  @c false otherwise.
+ * @retval  true if the node is the dummy element in the list.
+ * @retval  false otherwise.
  *
  * @param   pList               The list.
@@ -195 +195 @@
  * Checks if a list is empty.
  *
- * @retval  @c true if the list is empty.
- * @retval  @c false otherwise.
+ * @retval  true if the list is empty.
+ * @retval  false otherwise.
  *
  * @param   pList               The list to check.

trunk/include/iprt/mem.h

@@ -894 +894 @@
 /**
  * Fenced drop-in replacement for RTMemTmpFreeTag.
- * @copydoc RTMemTmpFreeTag
+ * @copydoc RTMemTmpFree
  */
 RTDECL(void)    RTMemEfTmpFreeNP(void *pv) RT_NO_THROW_PROTO;

trunk/include/iprt/uint128.h

@@ -744 +744 @@
     else if (cBits < 128)
         pValueResult->s.Hi &= (RT_BIT_64(cBits - 64) - 1);
-/** @todo #if ARCH_BITS >= 64 */
+/** @todo \#if ARCH_BITS >= 64 */
     return pValueResult;
 }
@@ -841 +841 @@
 {
     RTUINT128U const InVal = *pValueResult;
-/** @todo #if ARCH_BITS >= 64 */
+/** @todo \#if ARCH_BITS >= 64 */
     if (cBits > 0)
     {

trunk/src/VBox/Runtime/common/dbg/dbgmodcodeview.cpp

@@ -801 +801 @@
  * @returns IPRT status code
  * @param   pThis               The CodeView debug info reader instance.
- * @param   pbSymTab            The symbol table.
+ * @param   pvSymTab            The symbol table.
  * @param   cbSymTab            The size of the symbol table.
  * @param   fFlags              Flags reserved for future exploits, MBZ.
@@ -2469 +2469 @@
  * @param   off                 The offset where to expect CV debug info.
  * @param   cb                  The number of bytes of debug info.
+ * @param   enmArch             The desired image architecture.
  * @param   pszFilename         The path to the file (for logging).
  */
@@ -2549 +2550 @@
  *
  * @returns status code.
- * @param   pDbgMod             The debug module instance.  On success pvDbgPriv
+ * @param   pThis               The debug module instance.  On success pvDbgPriv
  *                              will point to a valid RTDBGMODCV.
  * @param   enmFileType         The kind of file this is we're probing.

trunk/src/VBox/Runtime/common/dbg/dbgmoddeferred.cpp

@@ -515 +515 @@
 
 /** @interface_method_impl{RTDBGMODVTIMG,pfnRvaToSegOffset} */
-static DECLCALLBACK(int) rtDbgModDeferredImg_RvaToSegOffset(PRTDBGMODINT pMod, RTLDRADDR uRva,
+static DECLCALLBACK(int) rtDbgModDeferredImg_RvaToSegOffset(PRTDBGMODINT pMod, RTLDRADDR Rva,
                                                             PRTDBGSEGIDX piSeg, PRTLDRADDR poffSeg)
 {
     int rc = rtDbgModDeferredDoIt(pMod, false /*fForceRetry*/);
     if (RT_SUCCESS(rc))
-        rc = pMod->pImgVt->pfnRvaToSegOffset(pMod, uRva, piSeg, poffSeg);
+        rc = pMod->pImgVt->pfnRvaToSegOffset(pMod, Rva, piSeg, poffSeg);
     return rc;
 }

trunk/src/VBox/Runtime/common/dbg/dbgmoddwarf.cpp

@@ -2137 +2137 @@
  * Check if the cursor is at the end of the current DWARF unit.
  *
- * @retval  @c true if at the end or a cursor error is pending.
- * @retval  @c false if not.
+ * @retval  true if at the end or a cursor error is pending.
+ * @retval  false if not.
  * @param   pCursor             The cursor.
  */
@@ -2166 +2166 @@
  * processing).
  *
- * @retval  @c true if at the end or a cursor error is pending.
- * @retval  @c false if not.
+ * @retval  true if at the end or a cursor error is pending.
+ * @retval  false if not.
  * @param   pCursor             The cursor.
  */
@@ -4015 +4015 @@
  *
  * @param   pThis               The DWARF instance.
- * @param   pParent             The parent DIE.
+ * @param   pParentDie          The parent DIE.
  */
 static void rtDwarfInfo_FreeChildren(PRTDBGMODDWARF pThis, PRTDWARFDIE pParentDie)

trunk/src/VBox/Runtime/common/path/RTPathGlob.cpp

@@ -376 +376 @@
 /**
  * Implements mapping a glob variable to multiple environment variable values.
+ *
+ * @param   a_Name              The variable name.
  * @param   a_apszVarNames      Assumes to be a global variable that RT_ELEMENTS
  *                              works correctly on.
+ * @param   a_cbMaxValue        The max expected value size.
  */
 #define RTPATHMATCHVAR_MULTIPLE_ENVVARS(a_Name, a_apszVarNames, a_cbMaxValue) \
@@ -451 +454 @@
 
 /**
- * @interface_method_impl{RTPATHMATCHVAR,pfnQuery, Enumerates the PATH}.
+ * @interface_method_impl{RTPATHMATCHVAR,pfnQuery, Enumerates the PATH}
  */
 static DECLCALLBACK(int) rtPathVarQuery_Path(uint32_t iItem, char *pszBuf, size_t cbBuf, size_t *pcchValue,
@@ -996 +999 @@
  * @param   pchPattern          The pattern to compile.
  * @param   cchPattern          The length of the pattern.
+ * @param   fIgnoreCase         Whether to ignore case or not when doing the
+ *                              actual matching later on.
  * @param   pAllocator          Pointer to the instruction allocator & result
  *                              array.  The compiled "program" starts at
@@ -1659 +1664 @@
  * @param   pGlob               The glob instance data.
  * @param   offPath             The current path offset/length.
- * @param   iComp               The current component.
+ * @param   iStarStarComp       The star-star component index.
+ * @param   offStarStarPath     The offset of the star-star component in the
+ *                              pattern path.
  */
 DECL_NO_INLINE(static, int) rtPathGlobExecRecursiveStarStar(PRTPATHGLOB pGlob, size_t offPath, uint32_t iStarStarComp,

trunk/src/VBox/Runtime/r0drv/nt/initterm-r0drv-nt.cpp

@@ -136 +136 @@
  * Tries a set against the current kernel.
  *
- * @retval @c true if it matched up, global variables are updated.
- * @retval @c false otherwise (no globals updated).
+ * @retval  true if it matched up, global variables are updated.
+ * @retval  false otherwise (no globals updated).
  * @param   pSet                The data set.
  * @param   pbPrcb              Pointer to the processor control block.

trunk/src/VBox/Runtime/r0drv/nt/mp-r0drv-nt.cpp

@@ -303 +303 @@
  *
  * @returns VINF_SUCCESS.
- * @param   pfnWorker   The callback.
- * @param   pvUser1     User argument 1.
- * @param   pvUser2     User argument 2.
- * @param   idCpu       First CPU to match, ultimately specific to the
- *                      pfnNativeWrapper used.
- * @param   idCpu2      Second CPU to match, ultimately specific to the
- *                      pfnNativeWrapper used.
- * @param   pcHits      Where to return the number of this. Optional.
+ * @param   pfnWorker           The callback.
+ * @param   pvUser1             User argument 1.
+ * @param   pvUser2             User argument 2.
+ * @param   pfnNativeWrapper    The wrapper between the NT and IPRT callbacks.
+ * @param   idCpu               First CPU to match, ultimately specific to the
+ *                              pfnNativeWrapper used.
+ * @param   idCpu2              Second CPU to match, ultimately specific to the
+ *                              pfnNativeWrapper used.
+ * @param   pcHits              Where to return the number of this. Optional.
  */
 static int rtMpCallUsingBroadcastIpi(PFNRTMPWORKER pfnWorker, void *pvUser1, void *pvUser2,

trunk/src/VBox/Runtime/r0drv/nt/ntBldSymDb.cpp

@@ -174 +174 @@
  * Returns the name we wish to use in the C code.
  * @returns Member name.
- * @param   pStruct             The member descriptor.
+ * @param   pMember             The member descriptor.
  */
 static const char *figureCMemberName(MYMEMBER const *pMember)
@@ -339 +339 @@
  * @returns Fully complained exit code.
  * @param   pOsVerInfo      The OS version info.
+ * @param   enmArch         The NT architecture of the incoming PDB.
+ * @param   pszPdb          The PDB file name.
  */
 static RTEXITCODE saveStructures(PRTNTSDBOSVER pOsVerInfo, MYARCH enmArch, const char *pszPdb)
@@ -987 +989 @@
  * @param   cchDir              The length of pszDir in pszDir.
  * @param   pDirEntry           Pointer to the directory buffer.
+ * @param   iLogDepth           The logging depth.
  */
 static RTEXITCODE processDirSub(char *pszDir, size_t cchDir, PRTDIRENTRYEX pDirEntry, int iLogDepth)

trunk/src/VBox/Runtime/r3/nt/pathint-nt.cpp

@@ -432 +432 @@
  * @param   pszPath             The UTF-8 path.
  * @param   fDesiredAccess      See NtCreateFile.
- * @param   fFileAttribs        See NtCreateFile.
  * @param   fShareAccess        See NtCreateFile.
- * @param   fCreateDisposition  See NtCreateFile.
  * @param   fCreateOptions      See NtCreateFile.
  * @param   fObjAttribs         The OBJECT_ATTRIBUTES::Attributes value, see

trunk/src/VBox/Runtime/r3/socket.cpp

@@ -282 +282 @@
  * @param   pAddr               Pointer to the generic IPRT network address.
  * @param   pDst                The source address.
- * @param   cbSrc               The size of the source address.
+ * @param   cbDst               The size of the source address.
  * @param   pcbAddr             Where to store the size of the returned address.
  *                              Optional

trunk/src/VBox/Runtime/r3/win/process-win.cpp

@@ -111 +111 @@
  * caller must also check if any of the necessary APIs are NULL pointers.
  * @{ */
-/** Init once structure for run-as-user functions we need.. */
+/** Init once structure for run-as-user functions we need. */
 static RTONCE                           g_rtProcWinResolveOnce          = RTONCE_INITIALIZER;
 /* kernel32.dll: */
@@ -1154 +1154 @@
  *
  * @returns true on success, false on failure.
- * @param   hWinStation         The window station.
+ * @param   hDesktop            The desktop handle.
  * @param   pSid                The SID.
  */