Changeset 25645 in vbox for trunk/src/VBox/Runtime/common

Timestamp:

Jan 5, 2010 9:29:31 AM (15 years ago)

Author:

vboxsync

Message:

IPRT,DoxyFile.Core: Mopped up the errors in the IPRT doxygen run.

Location:

trunk/src/VBox/Runtime/common

Files:

• checksum/ipv4.cpp (modified) (4 diffs)
• dbg/dbgas.cpp (modified) (4 diffs)
• dbg/dbgmod.cpp (modified) (1 diff)
• dbg/dbgmodcontainer.cpp (modified) (1 diff)
• dbg/dbgmodnm.cpp (modified) (1 diff)
• misc/cache.cpp (modified) (1 diff)
• misc/lockvalidator.cpp (modified) (2 diffs)
• misc/s3.cpp (modified) (4 diffs)
• misc/thread.cpp (modified) (2 diffs)
• path/RTPathParse.cpp (modified) (2 diffs)
• string/strformatrt.cpp (modified) (2 diffs)

trunk/src/VBox/Runtime/common/checksum/ipv4.cpp

@@ -228 +228 @@
  *
  * @returns 32-bit intermediary checksum value.
- * @param   pUdpHdr         Pointer to the TCP header to checksum, network endian (big).
- *                          Assums the caller has already validate it and made sure the
- *                          entire header is present.
+ * @param   pTcpHdr         Pointer to the TCP header to checksum, network
+ *                          endian (big). Assums the caller has already validate
+ *                          it and made sure the entire header is present.
  * @param   u32Sum          The 32-bit intermediate checksum value.
  */
@@ -274 +274 @@
  *
  * @returns 32-bit intermediary checksum value.
- * @param   pUdpHdr         Pointer to the TCP header to checksum, network endian (big).
- *                          Assums the caller has already validate it and made sure the
- *                          entire header is present.
+ * @param   pTcpHdr         Pointer to the TCP header to checksum, network
+ *                          endian (big). Assums the caller has already validate
+ *                          it and made sure the entire header is present.
  * @param   u32Sum          The 32-bit intermediate checksum value.
  */
@@ -290 +290 @@
  *
  * @returns 32-bit intermediary checksum value.
- * @param   pUdpHdr         Pointer to the UDP header to checksum, network endian (big).
+ * @param   pvData          Pointer to the data that should be checksummed.
+ * @param   cbData          The number of bytes to checksum.
  * @param   u32Sum          The 32-bit intermediate checksum value.
  * @param   pfOdd           This is used to keep track of odd bits, initialize to false
@@ -342 +343 @@
  *
  * @returns 32-bit intermediary checksum value.
- * @param   pUdpHdr         Pointer to the UDP header to checksum, network endian (big).
+ * @param   pvData          The data bits to checksum.
+ * @param   cbData          The number of bytes to checksum.
  * @param   u32Sum          The 32-bit intermediate checksum value.
  * @param   pfOdd           This is used to keep track of odd bits, initialize to false

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

@@ -1167 +1167 @@
  * Adjusts the address to correspond to the mapping of the module/segment.
  *
- * @param   pSymbol         The returned symbol info.
- * @param   pMap            The mapping record.
+ * @param   pAddr           The address to adjust (in/out).
+ * @param   iSeg            The related segment.
  * @param   hDbgMod         The module handle.
  * @param   MapAddr         The mapping address.
@@ -1259 +1259 @@
  * @param   cb              The size of the symbol.
  * @param   fFlags          Symbol flags.
+ * @param   piOrdinal       Where to return the symbol ordinal on success. If
+ *                          the interpreter doesn't do ordinals, this will be set to
+ *                          UINT32_MAX. Optional
  */
 RTDECL(int) RTDbgAsSymbolAdd(RTDBGAS hDbgAs, const char *pszSymbol, RTUINTPTR Addr, RTUINTPTR cb, uint32_t fFlags, uint32_t *piOrdinal)
@@ -1343 +1346 @@
  * @param   poffDisp        Where to return the distance between the symbol
  *                          and address. Optional.
- * @param   ppSymbol        Where to return the pointer to the allocated
- *                          symbol info. Always set. Free with RTDbgSymbolFree.
+ * @param   ppSymInfo       Where to return the pointer to the allocated symbol
+ *                          info. Always set. Free with RTDbgSymbolFree.
  * @param   phMod           Where to return the module handle. Optional.
  */
-RTDECL(int) RTDbgAsSymbolByAddrA(RTDBGAS hDbgAs, RTUINTPTR Addr, PRTINTPTR poffDisp, PRTDBGSYMBOL *ppSymbol, PRTDBGMOD phMod)
+RTDECL(int) RTDbgAsSymbolByAddrA(RTDBGAS hDbgAs, RTUINTPTR Addr, PRTINTPTR poffDisp, PRTDBGSYMBOL *ppSymInfo, PRTDBGMOD phMod)
 {
     /*
@@ -1369 +1372 @@
      * Forward the call.
      */
-    int rc = RTDbgModSymbolByAddrA(hMod, iSeg, offSeg, poffDisp, ppSymbol);
+    int rc = RTDbgModSymbolByAddrA(hMod, iSeg, offSeg, poffDisp, ppSymInfo);
     if (RT_SUCCESS(rc))
-        rtDbgAsAdjustSymbolValue(*ppSymbol, hMod, MapAddr, iSeg);
+        rtDbgAsAdjustSymbolValue(*ppSymInfo, hMod, MapAddr, iSeg);
     if (phMod)
         *phMod = hMod;

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

@@ -1291 +1291 @@
  *                              specified address and the returned symbol.
  *                              Optional.
- * @param   pSymInfo            Where to store the symbol information.
+ * @param   pLineInfo           Where to store the line number information.
  */
 RTDECL(int) RTDbgModLineByAddr(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, PRTINTPTR poffDisp, PRTDBGLINE pLineInfo)

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

@@ -530 +530 @@
 
 
-/** @copydoc RTDBGMODVTDBG::pfnRvaToSegOff */
+/** @copydoc RTDBGMODVTDBG::pfnImageSize */
 static DECLCALLBACK(RTUINTPTR) rtDbgModContainer_ImageSize(PRTDBGMODINT pMod)
 {

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

@@ -162 +162 @@
 
 
-/** @copydoc RTDBGMODVTDBG::pfnRvaToSegOff */
+/** @copydoc RTDBGMODVTDBG::pfnImageSize */
 static DECLCALLBACK(RTUINTPTR) rtDbgModNm_ImageSize(PRTDBGMODINT pMod)
 {

trunk/src/VBox/Runtime/common/misc/cache.cpp

@@ -50 +50 @@
  *
  * @returns iprt status code.
- * @param   ppObjCache    Where to store the pointer to the created cache.
- * @param   cElements     Number of elements the cache can hold.
- *                        0 if unlimited size.
- * @param   cbElement     Size of one element in bytes
- * @param   fProt         Protection flags for protecting cache against concurrent access
- *                        from different threads.
- *                        RTOBJCACHE_PROTECT_REQUESTER to protect the request function.
- *                        RTOBJCACHE_PROTECT_INSERT    to protect the insert function.
+ * @param   ppCache         Where to store the pointer to the created cache.
+ * @param   cElements       Number of elements the cache can hold.
+ *                          0 if unlimited size.
+ * @param   cbElement       Size of one element in bytes
+ * @param   fProt           Protection flags for protecting cache against
+ *                          concurrent access from different threads.
+ *                          RTOBJCACHE_PROTECT_REQUEST   to protect the request function.
+ *                          RTOBJCACHE_PROTECT_INSERT    to protect the insert function.
  */
 RTDECL(int) RTCacheCreate(PRTOBJCACHE *ppCache, uint32_t cElements, size_t cbElement, uint32_t fProt)

trunk/src/VBox/Runtime/common/misc/lockvalidator.cpp

@@ -188 +188 @@
  * Launch a simple assertion like complaint w/ panic.
  *
- * @param   RT_SRC_POS_DECL     Where from.
+ * @param   pszFile             Where from - file.
+ * @param   iLine               Where from - line.
+ * @param   pszFunction         Where from - function.
  * @param   pszWhat             What we're complaining about.
  * @param   ...                 Format arguments.
@@ -211 +213 @@
  *
  * @param   pszPrefix           Message prefix.
- * @param   Rec                 The lock record we're working on.
- * @param   pszPrefix           Message suffix.
+ * @param   pRec                The lock record we're working on.
+ * @param   pszSuffix           Message suffix.
  */
 static void rtLockValidatorComplainAboutLock(const char *pszPrefix, PRTLOCKVALRECUNION pRec, const char *pszSuffix)

trunk/src/VBox/Runtime/common/misc/s3.cpp

@@ -863 +863 @@
 }
 
-RTR3DECL(int) RTS3GetKey(RTS3 hS3, const char* pszBucketName, const char* pszKeyName, const char* pszFileName)
+RTR3DECL(int) RTS3GetKey(RTS3 hS3, const char *pszBucketName, const char *pszKeyName, const char *pszFilename)
 {
     PRTS3INTERNAL pS3Int = hS3;
@@ -873 +873 @@
     /* Open the file */
     RTFILE hFile;
-    int rc = RTFileOpen(&hFile, pszFileName, RTFILE_O_CREATE | RTFILE_O_WRITE | RTFILE_O_DENY_NONE);
+    int rc = RTFileOpen(&hFile, pszFilename, RTFILE_O_CREATE | RTFILE_O_WRITE | RTFILE_O_DENY_NONE);
     if (RT_FAILURE(rc))
         return rc;
@@ -916 +916 @@
     /* If there was an error delete the newly created file */
     if (RT_FAILURE(rc))
-        RTFileDelete(pszFileName);
+        RTFileDelete(pszFilename);
 
     return rc;
 }
 
-RTR3DECL(int) RTS3PutKey(RTS3 hS3, const char* pszBucketName, const char* pszKeyName, const char* pszFileName)
+RTR3DECL(int) RTS3PutKey(RTS3 hS3, const char *pszBucketName, const char *pszKeyName, const char *pszFilename)
 {
     PRTS3INTERNAL pS3Int = hS3;
@@ -931 +931 @@
     /* Open the file */
     RTFILE hFile;
-    int rc = RTFileOpen(&hFile, pszFileName, RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_NONE);
+    int rc = RTFileOpen(&hFile, pszFilename, RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_NONE);
     if (RT_FAILURE(rc))
         return rc;

trunk/src/VBox/Runtime/common/misc/thread.cpp

@@ -779 +779 @@
  * @param   enmType     See RTThreadCreate.
  * @param   fFlags      See RTThreadCreate.
- * @param   pszName     Thread name format.
+ * @param   pszNameFmt  Thread name format.
  * @param   va          Format arguments.
  */
@@ -804 +804 @@
  * @param   enmType     See RTThreadCreate.
  * @param   fFlags      See RTThreadCreate.
- * @param   pszName     Thread name format.
+ * @param   pszNameFmt  Thread name format.
  * @param   ...         Format arguments.
  */

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

@@ -46 +46 @@
  *
  * @param   pszPath     Path to find filename in.
- * @param   pcbDir      Where to put the length of the directory component.
- *                      If no directory, this will be 0. Optional.
+ * @param   pcchDir     Where to put the length of the directory component. If
+ *                      no directory, this will be 0. Optional.
  * @param   poffName    Where to store the filename offset.
  *                      If empty string or if it's ending with a slash this
@@ -54 +54 @@
  *                      If empty string or if it's ending with a slash this
  *                      will be set to -1. Optional.
- * @param   pfFlags     Where to set flags returning more information about
- *                      the path. For the future. Optional.
  */
 RTDECL(size_t) RTPathParse(const char *pszPath, size_t *pcchDir, ssize_t *poffName, ssize_t *poffSuff)

trunk/src/VBox/Runtime/common/string/strformatrt.cpp

@@ -82 +82 @@
  *      - \%RHx             - Takes a #RTHCUINT or #RTHCINT value, formatting it as hex.
  *      - \%RRv             - Takes a #RTRCPTR, #RTRCINTPTR or #RTRCUINTPTR value.
- *      - \%RCi             - Takes a #RTCCINT value.
+ *      - \%RCi             - Takes a #RTINT value.
  *      - \%RCp             - Takes a #RTCCPHYS value.
  *      - \%RCr             - Takes a #RTCCUINTREG value.
@@ -233 +233 @@
 #define STRMEM(str) sizeof(str) - 1, str
                     { STRMEM("Ci"),      sizeof(RTINT),          10, RTSF_INT,   RTSTR_F_VALSIGNED },
-                    { STRMEM("Cp"),      sizeof(RTGCPHYS),       16, RTSF_INTW,  0 },
+                    { STRMEM("Cp"),      sizeof(RTCCPHYS),       16, RTSF_INTW,  0 },
                     { STRMEM("Cr"),      sizeof(RTCCUINTREG),    16, RTSF_INTW,  0 },
                     { STRMEM("Cu"),      sizeof(RTUINT),         10, RTSF_INT,   0 },