VirtualBox

Changeset 57944 in vbox


Ignore:
Timestamp:
Sep 29, 2015 3:07:09 PM (10 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
102919
Message:

iprt: More doxygen corrections.

Location:
trunk
Files:
40 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/iprt/cdefs.h

    r57926 r57944  
    14471447 * @param   b       The 2nd part.
    14481448 * @param   c       The 3rd part.
     1449 * @param   d       The 4th part.
    14491450 */
    14501451#define RT_CONCAT4(a,b,c,d)         RT_CONCAT4_HLP(a,b,c,d)

  • trunk/include/iprt/cpp/list.h

    r56291 r57944  
    208208     * This preallocates @a cCapacity elements within the list.
    209209     *
    210      * @param   cCapacitiy   The initial capacity the list has.
     210     * @param   cCapacity    The initial capacity the list has.
    211211     * @throws  std::bad_alloc
    212212     */
    … …  
    924924     * This preallocates @a cCapacity elements within the list.
    925925     *
    926      * @param   cCapacitiy   The initial capacity the list has.
     926     * @param   cCapacity    The initial capacity the list has.
    927927     * @throws  std::bad_alloc
    928928     */
    … …  
    955955     * This preallocates @a cCapacity elements within the list.
    956956     *
    957      * @param   cCapacitiy   The initial capacity the list has.
     957     * @param   cCapacity    The initial capacity the list has.
    958958     * @throws  std::bad_alloc
    959959     */
    … …  
    983983     * This preallocates @a cCapacity elements within the list.
    984984     *
    985      * @param   cCapacitiy   The initial capacity the list has.
     985     * @param   cCapacity    The initial capacity the list has.
    986986     * @throws  std::bad_alloc
    987987     */

  • trunk/include/iprt/cpp/ministring.h

    r57005 r57944  
    428428     * Shortcut to append(), char variant.
    429429     *
    430      * @param pszThat           The character to append.
     430     * @param ch                The character to append.
    431431     *
    432432     * @returns                 Reference to the object.
    433433     */
    434     RTCString &operator+=(char c)
    435     {
    436         return append(c);
     434    RTCString &operator+=(char ch)
     435    {
     436        return append(ch);
    437437    }
    438438
    … …  
    603603     * Compares the member string to another RTCString.
    604604     *
    605      * @param   pcszThat    The string to compare with.
     605     * @param   rThat       The string to compare with.
    606606     * @param   cs          Whether comparison should be case-sensitive.
    607607     * @returns 0 if equal, negative if this is smaller than @a pcsz, positive
    608608     *          if larger.
    609609     */
    610     int compare(const RTCString &that, CaseSensitivity cs = CaseSensitive) const
     610    int compare(const RTCString &rThat, CaseSensitivity cs = CaseSensitive) const
    611611    {
    612612        if (cs == CaseSensitive)
    613             return ::RTStrCmp(m_psz, that.m_psz);
    614         return ::RTStrICmp(m_psz, that.m_psz);
     613            return ::RTStrCmp(m_psz, rThat.m_psz);
     614        return ::RTStrICmp(m_psz, rThat.m_psz);
    615615    }
    616616
    … …  
    619619     *
    620620     * @returns true if equal, false if not.
    621      * @param   that    The string to compare with.
    622      */
    623     bool equals(const RTCString &that) const
    624     {
    625         return that.length() == length()
    626             && memcmp(that.m_psz, m_psz, length()) == 0;
     621     * @param   rThat    The string to compare with.
     622     */
     623    bool equals(const RTCString &rThat) const
     624    {
     625        return rThat.length() == length()
     626            && memcmp(rThat.m_psz, m_psz, length()) == 0;
    627627    }
    628628

  • trunk/include/iprt/cpp/mtlist.h

    r56291 r57944  
    101101     * This preallocates @a cCapacity elements within the list.
    102102     *
    103      * @param   cCapacitiy   The initial capacity the list has.
     103     * @param   cCapacity    The initial capacity the list has.
    104104     * @throws  std::bad_alloc
    105105     */
    … …  
    129129     * This preallocates @a cCapacity elements within the list.
    130130     *
    131      * @param   cCapacitiy   The initial capacity the list has.
     131     * @param   cCapacity    The initial capacity the list has.
    132132     * @throws  std::bad_alloc
    133133     */
    … …  
    157157     * This preallocates @a cCapacity elements within the list.
    158158     *
    159      * @param   cCapacitiy   The initial capacity the list has.
     159     * @param   cCapacity    The initial capacity the list has.
    160160     * @throws  std::bad_alloc
    161161     */

  • trunk/include/iprt/cpp/xml.h

    r56291 r57944  
    601601     *                              simple path to any decendant.
    602602     * @param   pcszAttribute       The attribute name.
    603      * @param   pcszPathNamespace   The namespace to match @pcszPath with, NULL
     603     * @param   pcszPathNamespace   The namespace to match @a pcszPath with, NULL
    604604     *                              (default) match any namespace.  When using a
    605605     *                              path, this matches all elements along the way.
    606      * @param   pcszAttribNamespace The namespace prefix to apply to the attribute,
    607      *                              NULL (default) match any namespace.
     606     * @param   pcszAttributeNamespace  The namespace prefix to apply to the
     607     *                              attribute, NULL (default) match any namespace.
    608608     * @see     findChildElementP and findAttributeValue
    609609     */

  • trunk/include/iprt/dbg.h

    r57004 r57944  
    444444 * @param   pvUser2             Second user parameter.
    445445 */
    446 typedef DECLCALLBACK(int) FNDBGCFGOPEN(RTDBGCFG hDbgCfg, const char *pszFilename, void *pvUser1, void *pvUser2);
     446typedef DECLCALLBACK(int) FNRTDBGCFGOPEN(RTDBGCFG hDbgCfg, const char *pszFilename, void *pvUser1, void *pvUser2);
    447447/** Pointer to a open-file callback used to the RTDbgCfgOpen functions. */
    448 typedef FNDBGCFGOPEN *PFNDBGCFGOPEN;
     448typedef FNRTDBGCFGOPEN *PFNRTDBGCFGOPEN;
    449449
    450450
    451451RTDECL(int) RTDbgCfgOpenPeImage(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t cbImage, uint32_t uTimestamp,
    452                                 PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
     452                                PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
    453453RTDECL(int) RTDbgCfgOpenPdb70(RTDBGCFG hDbgCfg, const char *pszFilename, PCRTUUID pUuid, uint32_t uAge,
    454                               PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
     454                              PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
    455455RTDECL(int) RTDbgCfgOpenPdb20(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t cbImage, uint32_t uTimestamp, uint32_t uAge,
    456                               PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
     456                              PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
    457457RTDECL(int) RTDbgCfgOpenDbg(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t cbImage, uint32_t uTimestamp,
    458                             PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
     458                            PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
    459459RTDECL(int) RTDbgCfgOpenDwo(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t uCrc32,
    460                             PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
     460                            PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
    461461RTDECL(int) RTDbgCfgOpenDsymBundle(RTDBGCFG hDbgCfg, const char *pszFilename, PCRTUUID pUuid,
    462                                    PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
     462                                   PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
    463463RTDECL(int) RTDbgCfgOpenMachOImage(RTDBGCFG hDbgCfg, const char *pszFilename, PCRTUUID pUuid,
    464                                    PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
     464                                   PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
    465465
    466466

  • trunk/include/iprt/getopt.h

    r57926 r57944  
    454454 * @param   ppwszCmdLine    Where to return the command line string.  This must
    455455 *                          be freed by calling RTUtf16Free.
    456  * @param   papszArgs       The argument vector to convert.
     456 * @param   papszArgv       The argument vector to convert.
    457457 * @param   fFlags          A combination of the RTGETOPTARGV_CNV_XXX flags.
    458458 */

  • trunk/include/iprt/ldr.h

    r57926 r57944  
    635635 * @param   pvUser          The user argument specified to RTLdrEnumSymbols().
    636636 */
    637 typedef DECLCALLBACK(int) RTLDRENUMSYMS(RTLDRMOD hLdrMod, const char *pszSymbol, unsigned uSymbol, RTLDRADDR Value, void *pvUser);
    638 /** Pointer to a RTLDRENUMSYMS() callback function. */
    639 typedef RTLDRENUMSYMS *PFNRTLDRENUMSYMS;
     637typedef DECLCALLBACK(int) FNRTLDRENUMSYMS(RTLDRMOD hLdrMod, const char *pszSymbol, unsigned uSymbol, RTLDRADDR Value, void *pvUser);
     638/** Pointer to a FNRTLDRENUMSYMS() callback function. */
     639typedef FNRTLDRENUMSYMS *PFNRTLDRENUMSYMS;
    640640
    641641/**
    … …  
    931931 *
    932932 * @param   hLdrMod         The module handle.
    933  * @param   Rva             The segment index.
     933 * @param   iSeg            The segment index.
    934934 * @param   offSeg          The segment offset.
    935935 * @param   pRva            Where to return the RVA.
    … …  
    10711071 *                          Optional.
    10721072 */
    1073 RTDECL(int) RTLdrQueryPropEx(RTLDRMOD hLdrMod, RTLDRPROP enmProp, void *pvBits, void *pvBuf, size_t cbBuf, size_t *pcbBuf);
     1073RTDECL(int) RTLdrQueryPropEx(RTLDRMOD hLdrMod, RTLDRPROP enmProp, void *pvBits, void *pvBuf, size_t cbBuf, size_t *pcbRet);
    10741074
    10751075

  • trunk/include/iprt/mem.h

    r57926 r57944  
    721721 *
    722722 * @param   pv      Pointer to memory block.
     723 * @param   SRC_POS The source position where call is being made from.  Use
     724 *                  RT_SRC_POS when possible.  Optional.
    723725 */
    724726RTDECL(void)    RTMemEfFree(void *pv, RT_SRC_POS_DECL) RT_NO_THROW_PROTO;

  • trunk/include/iprt/sort.h

    r56291 r57944  
    5555 * @param   papvArray       The array to sort.
    5656 * @param   cElements       The number of elements in the array.
    57  * @param   cbElements      The size of an array element.
     57 * @param   cbElement       The size of an array element.
    5858 * @param   pfnCmp          Callback function comparing two elements.
    5959 * @param   pvUser          User argument for the callback.
    … …  
    7878 * Shell sort an array of variable sized elementes.
    7979 *
    80  * @param   papvArray       The array to sort.
     80 * @param   pvArray         The array to sort.
    8181 * @param   cElements       The number of elements in the array.
    82  * @param   cbElements      The size of an array element.
     82 * @param   cbElement       The size of an array element.
    8383 * @param   pfnCmp          Callback function comparing two elements.
    8484 * @param   pvUser          User argument for the callback.
    … …  
    101101 *
    102102 * @returns true if it is sorted, false if it isn't.
    103  * @param   papvArray       The array to check.
     103 * @param   pvArray         The array to check.
    104104 * @param   cElements       The number of elements in the array.
    105  * @param   cbElements      The size of an array element.
     105 * @param   cbElement       The size of an array element.
    106106 * @param   pfnCmp          Callback function comparing two elements.
    107107 * @param   pvUser          User argument for the callback.

  • trunk/include/iprt/tcp.h

    r53615 r57944  
    5353 * @returns VERR_TCP_SERVER_STOP to terminate the server loop forcing
    5454 *          the RTTcpCreateServer() call to return.
    55  * @param   Sock        The socket which the client is connected to.
    56  *                      The call will close this socket.
     55 * @param   hSocket     The socket which the client is connected to. The call
     56 *                      will close this socket.
    5757 * @param   pvUser      User argument.
    5858 */
    59 typedef DECLCALLBACK(int) FNRTTCPSERVE(RTSOCKET Sock, void *pvUser);
     59typedef DECLCALLBACK(int) FNRTTCPSERVE(RTSOCKET hSocket, void *pvUser);
    6060/** Pointer to a RTTCPSERVE(). */
    6161typedef FNRTTCPSERVE *PFNRTTCPSERVE;
    … …  
    213213 *
    214214 * @returns iprt status code.
    215  * @param   Sock        Socket descriptor.
    216  */
    217 RTR3DECL(int) RTTcpClientClose(RTSOCKET Sock);
     215 * @param   hSocket     Socket descriptor.
     216 */
     217RTR3DECL(int) RTTcpClientClose(RTSOCKET hSocket);
    218218
    219219/**
    … …  
    228228 *                              further ado.
    229229 */
    230 RTR3DECL(int) RTTcpClientCloseEx(RTSOCKET Sock, bool fGracefulShutdown);
     230RTR3DECL(int) RTTcpClientCloseEx(RTSOCKET hSocket, bool fGracefulShutdown);
    231231
    232232/**
    … …  
    234234 *
    235235 * @returns iprt status code.
    236  * @param   Sock        Socket descriptor.
     236 * @param   hSocket     Socket descriptor.
    237237 * @param   pvBuffer    Where to put the data we read.
    238238 * @param   cbBuffer    Read buffer size.
    … …  
    241241 *                      If not NULL a partial read can be done successfully.
    242242 */
    243 RTR3DECL(int)  RTTcpRead(RTSOCKET Sock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead);
     243RTR3DECL(int)  RTTcpRead(RTSOCKET hSocket, void *pvBuffer, size_t cbBuffer, size_t *pcbRead);
    244244
    245245/**
    … …  
    249249 * @retval  VERR_INTERRUPTED if interrupted before anything was written.
    250250 *
    251  * @param   Sock        Socket descriptor.
     251 * @param   hSocket     Socket descriptor.
    252252 * @param   pvBuffer    Buffer to write data to socket.
    253253 * @param   cbBuffer    How much to write.
    254254 */
    255 RTR3DECL(int)  RTTcpWrite(RTSOCKET Sock, const void *pvBuffer, size_t cbBuffer);
     255RTR3DECL(int)  RTTcpWrite(RTSOCKET hSocket, const void *pvBuffer, size_t cbBuffer);
    256256
    257257/**
    … …  
    259259 *
    260260 * @returns iprt status code.
    261  * @param   Sock        Socket descriptor.
    262  */
    263 RTR3DECL(int)  RTTcpFlush(RTSOCKET Sock);
     261 * @param   hSocket     Socket descriptor.
     262 */
     263RTR3DECL(int)  RTTcpFlush(RTSOCKET hSocket);
    264264
    265265/**
    … …  
    270270 *
    271271 * @returns iprt status code.
    272  * @param   Sock        Socket descriptor.
     272 * @param   hSocket     Socket descriptor.
    273273 * @param   fEnable     When set to true enables coalescing.
    274274 */
    275 RTR3DECL(int)  RTTcpSetSendCoalescing(RTSOCKET Sock, bool fEnable);
     275RTR3DECL(int)  RTTcpSetSendCoalescing(RTSOCKET hSocket, bool fEnable);
    276276
    277277/**
    … …  
    280280 *
    281281 * @returns iprt status code.
    282  * @param   Sock        Socket descriptor.
     282 * @param   hSocket     Socket descriptor.
    283283 * @param   cMillies    Number of milliseconds to wait for the socket.
    284284 *                      Use RT_INDEFINITE_WAIT to wait for ever.
    285285 */
    286 RTR3DECL(int)  RTTcpSelectOne(RTSOCKET Sock, RTMSINTERVAL cMillies);
     286RTR3DECL(int)  RTTcpSelectOne(RTSOCKET hSocket, RTMSINTERVAL cMillies);
    287287
    288288/**
    … …  
    291291 *
    292292 * @returns iprt status code.
    293  * @param   Sock        Socket descriptor.
     293 * @param   hSocket     Socket descriptor.
    294294 * @param   fEvents     Event mask to wait for.
    295295 *                      Use the RTSOCKET_EVT_* defines.
    … …  
    298298 *                      Use RT_INDEFINITE_WAIT to wait for ever.
    299299 */
    300 RTR3DECL(int)  RTTcpSelectOneEx(RTSOCKET Sock, uint32_t fEvents, uint32_t *pfEvents,
    301                                 RTMSINTERVAL cMillies);
     300RTR3DECL(int)  RTTcpSelectOneEx(RTSOCKET hSocket, uint32_t fEvents, uint32_t *pfEvents, RTMSINTERVAL cMillies);
    302301
    303302#if 0 /* skipping these for now - RTTcpServer* handles this. */
    … …  
    306305 *
    307306 * @returns iprt status code.
    308  * @param   Sock        Socket descriptor.
     307 * @param   hSocket     Socket descriptor.
    309308 * @param   cBackLog    The maximum length the queue of pending connections
    310309 *                      may grow to.
    311310 */
    312 RTR3DECL(int)  RTTcpListen(RTSOCKET Sock, int cBackLog);
     311RTR3DECL(int)  RTTcpListen(RTSOCKET hSocket, int cBackLog);
    313312
    314313/**
    … …  
    316315 *
    317316 * @returns iprt status code.
    318  * @param   Sock            Socket descriptor.
     317 * @param   hSocket         Socket descriptor.
    319318 * @param   uPort           The port for accepting connection.
    320319 * @param   pSockAccepted   Where to store the handle to the accepted connection.
    321320 */
    322 RTR3DECL(int)  RTTcpAccept(RTSOCKET Sock, unsigned uPort, PRTSOCKET pSockAccepted);
     321RTR3DECL(int)  RTTcpAccept(RTSOCKET hSocket, unsigned uPort, PRTSOCKET pSockAccepted);
    323322
    324323#endif
    … …  
    328327 *
    329328 * @returns IPRT status code.
    330  * @param   Sock            Socket descriptor.
     329 * @param   hSocket         Socket descriptor.
    331330 * @param   pAddr           Where to store the local address on success.
    332331 */
    333 RTR3DECL(int) RTTcpGetLocalAddress(RTSOCKET Sock, PRTNETADDR pAddr);
     332RTR3DECL(int) RTTcpGetLocalAddress(RTSOCKET hSocket, PRTNETADDR pAddr);
    334333
    335334/**
    … …  
    337336 *
    338337 * @returns IPRT status code.
    339  * @param   Sock            Socket descriptor.
     338 * @param   hSocket         Socket descriptor.
    340339 * @param   pAddr           Where to store the peer address on success.
    341340 */
    342 RTR3DECL(int) RTTcpGetPeerAddress(RTSOCKET Sock, PRTNETADDR pAddr);
     341RTR3DECL(int) RTTcpGetPeerAddress(RTSOCKET hSocket, PRTNETADDR pAddr);
    343342
    344343/**
    … …  
    348347 * @retval  VERR_INTERRUPTED if interrupted before anything was written.
    349348 *
    350  * @param   Sock        Socket descriptor.
     349 * @param   hSocket     Socket descriptor.
    351350 * @param   pSgBuf      Scatter/gather buffer to write data to socket.
    352351 */
    353 RTR3DECL(int)  RTTcpSgWrite(RTSOCKET Sock, PCRTSGBUF pSgBuf);
     352RTR3DECL(int)  RTTcpSgWrite(RTSOCKET hSocket, PCRTSGBUF pSgBuf);
    354353
    355354
    … …  
    399398 * @returns IPRT status code.
    400399 *
    401  * @param   Sock        Socket descriptor.
     400 * @param   hSocket     Socket descriptor.
    402401 * @param   pvBuffer    Where to put the data we read.
    403402 * @param   cbBuffer    Read buffer size.
    404403 * @param   pcbRead     Number of bytes read.
    405404 */
    406 RTR3DECL(int)  RTTcpReadNB(RTSOCKET Sock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead);
     405RTR3DECL(int)  RTTcpReadNB(RTSOCKET hSocket, void *pvBuffer, size_t cbBuffer, size_t *pcbRead);
    407406
    408407/**
    … …  
    413412 * @returns IPRT status code.
    414413 *
    415  * @param   Sock        Socket descriptor.
     414 * @param   hSocket     Socket descriptor.
    416415 * @param   pvBuffer    Buffer to write data to socket.
    417416 * @param   cbBuffer    How much to write.
    418417 * @param   pcbWritten  Number of bytes written.
    419418 */
    420 RTR3DECL(int)  RTTcpWriteNB(RTSOCKET Sock, const void *pvBuffer, size_t cbBuffer, size_t *pcbWritten);
     419RTR3DECL(int)  RTTcpWriteNB(RTSOCKET hSocket, const void *pvBuffer, size_t cbBuffer, size_t *pcbWritten);
    421420
    422421/**
    … …  
    428427 * @retval  VERR_INTERRUPTED if interrupted before anything was written.
    429428 *
    430  * @param   Sock        Socket descriptor.
     429 * @param   hSocket     Socket descriptor.
    431430 * @param   pSgBuf      Scatter/gather buffer to write data to socket.
    432431 * @param   pcbWritten  Number of bytes written.
    433432 */
    434 RTR3DECL(int)  RTTcpSgWriteNB(RTSOCKET Sock, PCRTSGBUF pSgBuf, size_t *pcbWritten);
     433RTR3DECL(int)  RTTcpSgWriteNB(RTSOCKET hSocket, PCRTSGBUF pSgBuf, size_t *pcbWritten);
    435434
    436435

  • trunk/include/iprt/test.h

    r57004 r57944  
    175175 * @param   phTest      Where to store the test instance handle.
    176176 */
    177 RTR3DECL(RTEXITCODE) RTTestInitExAndCreate(int cArgs, char ***papszArgs, uint32_t fRtInit, const char *pszTest, PRTTEST phTest);
     177RTR3DECL(RTEXITCODE) RTTestInitExAndCreate(int cArgs, char ***ppapszArgs, uint32_t fRtInit, const char *pszTest, PRTTEST phTest);
    178178
    179179/**
    … …  
    540540 * @param   enmUnit     The value unit.
    541541 * @param   pszNameFmt  The value name format string.
    542  * @param   va_list     String arguments.
     542 * @param   va          String arguments.
    543543 */
    544544RTR3DECL(int) RTTestValueV(RTTEST hTest, uint64_t u64Value, RTTESTUNIT enmUnit,
    … …  
    991991 * @param   enmUnit     The value unit.
    992992 * @param   pszNameFmt  The value name format string.
    993  * @param   va_list     String arguments.
     993 * @param   va          String arguments.
    994994 */
    995995RTR3DECL(int) RTTestIValueV(uint64_t u64Value, RTTESTUNIT enmUnit, const char *pszNameFmt, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
    … …  
    11561156 * @param   DetailsArgs     Argument list for RTTestIFailureDetails, including
    11571157 *                          parenthesis.
    1158  * @param   rcRet           What to return on failure.
    11591158 */
    11601159#define RTTESTI_CHECK_MSG_BREAK(expr, DetailsArgs) \

  • trunk/include/iprt/udp.h

    r56291 r57944  
    132132 * @param   cbBuffer    Read buffer size.
    133133 * @param   pcbRead     Number of bytes read. Must be non-NULL.
     134 * @param   pSrcAddr    The network address to read from.
    134135 */
    135136RTR3DECL(int)  RTUdpRead(RTSOCKET Sock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead, PRTNETADDR pSrcAddr);

  • trunk/include/iprt/uint128.h

    r53615 r57944  
    495495 * Assigns a boolean value to 128-bit unsigned integer.
    496496 *
    497  * @returns pResult
    498  * @param   pResult             The result variable.
     497 * @returns pValueResult
     498 * @param   pValueResult        The result variable.
    499499 * @param   fValue              The boolean value.
    500500 */
    … …  
    517517 * Assigns a 8-bit unsigned integer value to 128-bit unsigned integer.
    518518 *
    519  * @returns pResult
    520  * @param   pResult             The result variable.
     519 * @returns pValueResult
     520 * @param   pValueResult        The result variable.
    521521 * @param   u8Value             The 8-bit unsigned integer value.
    522522 */
    … …  
    539539 * Assigns a 16-bit unsigned integer value to 128-bit unsigned integer.
    540540 *
    541  * @returns pResult
    542  * @param   pResult             The result variable.
     541 * @returns pValueResult
     542 * @param   pValueResult        The result variable.
    543543 * @param   u16Value            The 16-bit unsigned integer value.
    544544 */
    … …  
    561561 * Assigns a 16-bit unsigned integer value to 128-bit unsigned integer.
    562562 *
    563  * @returns pResult
    564  * @param   pResult             The result variable.
     563 * @returns pValueResult
     564 * @param   pValueResult        The result variable.
    565565 * @param   u32Value            The 32-bit unsigned integer value.
    566566 */
    … …  
    583583 * Assigns a 64-bit unsigned integer value to 128-bit unsigned integer.
    584584 *
    585  * @returns pResult
    586  * @param   pResult             The result variable.
    587  * @param   u32Value            The 32-bit unsigned integer value.
     585 * @returns pValueResult
     586 * @param   pValueResult        The result variable.
     587 * @param   u64Value            The 64-bit unsigned integer value.
    588588 */
    589589DECLINLINE(PRTUINT128U) RTUInt128AssignU64(PRTUINT128U pValueResult, uint64_t u64Value)
    … …  
    834834 * the result to it.
    835835 *
    836  * @returns pValue1Result.
    837  * @param   pValue1Result   The first value and result.
     836 * @returns pValueResult.
     837 * @param   pValueResult    The first value and result.
    838838 * @param   cBits           The number of bits to shift.
    839839 */
    … …  
    885885 * the result to it.
    886886 *
    887  * @returns pValue1Result.
    888  * @param   pValue1Result   The first value and result.
     887 * @returns pValueResult.
     888 * @param   pValueResult    The first value and result.
    889889 * @param   cBits           The number of bits to shift.
    890890 */

  • trunk/include/iprt/uri.h

    r57825 r57944  
    297297 * @param   pszUri              The URI to extract from.
    298298 * @param   uFormat             In which format should the path returned.
    299  * @param   cbMax               The max string length to inspect.
     299 * @param   cchMax              The max string length to inspect.
    300300 */
    301301RTDECL(char *) RTUriFileNPath(const char *pszUri, uint32_t uFormat, size_t cchMax);

  • trunk/include/iprt/vfs.h

    r57643 r57944  
    227227 *
    228228 * @returns Referenced handle on success, NIL if the input handle was invalid.
    229  * @param   hVfsFSs         The VFS filesystem stream handle.
     229 * @param   hVfsFss         The VFS filesystem stream handle.
    230230 */
    231231RTDECL(RTVFSOBJ)        RTVfsObjFromFsStream(RTVFSFSSTREAM hVfsFss);
    … …  
    298298 * @retval  VERR_EOF when there are no more objects.
    299299 *
    300  * @param   pvThis      The implementation specific directory data.
     300 * @param   hVfsFss     The file system stream handle.
    301301 * @param   ppszName    Where to return the object name.  Must be freed by
    302302 *                      calling RTStrFree.
    303303 * @param   penmType    Where to return the object type.
    304  * @param   hVfsObj     Where to return the object handle (referenced).
    305  *                      This must be cast to the desired type before use.
     304 * @param   phVfsObj    Where to return the object handle (referenced). This
     305 *                      must be cast to the desired type before use.
    306306 */
    307307RTDECL(int)         RTVfsFsStrmNext(RTVFSFSSTREAM hVfsFss, char **ppszName, RTVFSOBJTYPE *penmType, PRTVFSOBJ phVfsObj);
    … …  
    326326 *
    327327 * @returns New reference count on success (0 if closed), UINT32_MAX on failure.
    328  * @param   hVfsIos         The VFS directory handle.
     328 * @param   hVfsDir         The VFS directory handle.
    329329 */
    330330RTDECL(uint32_t)    RTVfsDirRelease(RTVFSDIR hVfsDir);
    … …  
    567567 * @param   fBlocking       Whether the call is blocking (@c true) or not.  If
    568568 *                          not, the @a pcbWritten parameter must not be NULL.
    569  * @param   pcbRead         Where to always store the number of bytes actually
     569 * @param   pcbWritten      Where to always store the number of bytes actually
    570570 *                          written.  This can be NULL if @a fBlocking is true.
    571571 * @sa      RTVfsFileWrite, RTFileWrite, RTPipeWrite, RTPipeWriteBlocking,
    … …  
    771771 *          implementation.
    772772 *
    773  * @param   hVfsObj         The VFS object handle.
     773 * @param   hVfsFile        The VFS file handle.
    774774 * @param   pObjInfo        Where to return the info.
    775775 * @param   enmAddAttr      Which additional attributes should be retrieved.
    … …  
    801801 * @param   pvBuf           Where to store the read bytes.
    802802 * @param   cbToRead        The number of bytes to read.
    803  * @param   fBlocking       Whether the call is blocking (@c true) or not.  If
    804  *                          not, the @a pcbRead parameter must not be NULL.
    805803 * @param   pcbRead         Where to always store the number of bytes actually
    806  *                          read.  This can be NULL if @a fBlocking is true.
     804 *                          read.  Optional.
    807805 * @sa      RTVfsIoStrmRead, RTFileRead, RTPipeRead, RTPipeReadBlocking,
    808806 *          RTSocketRead
    … …  
    820818 * @param   pvBuf           The bytes to write.
    821819 * @param   cbToWrite       The number of bytes to write.
    822  * @param   fBlocking       Whether the call is blocking (@c true) or not.  If
    823  *                          not, the @a pcbWritten parameter must not be NULL.
    824  * @param   pcbRead         Where to always store the number of bytes actually
    825  *                          written.  This can be NULL if @a fBlocking is true.
     820 * @param   pcbWritten      Where to always store the number of bytes actually
     821 *                          written.  This can be NULL.
    826822 * @sa      RTVfsIoStrmRead, RTFileWrite, RTPipeWrite, RTPipeWriteBlocking,
    827823 *          RTSocketWrite
    … …  
    910906 *
    911907 * The data is read in chunks from @a hVfsIosSrc and written to @a hVfsIosDst
    912  * until @hVfsIosSrc indicates end of stream.
     908 * until @a hVfsIosSrc indicates end of stream.
    913909 *
    914910 * @returns IPRT status code

  • trunk/include/iprt/vfslowlevel.h

    r56291 r57944  
    237237 *
    238238 * @returns IPRT status code
    239  * @param   pVfs Ops            The VFS operations.
     239 * @param   pVfsOps             The VFS operations.
    240240 * @param   cbInstance          The size of the instance data.
    241241 * @param   hVfs                The VFS handle to associate this VFS with.
    … …  
    303303 *                              object.  The reference is consumed.  NIL and
    304304 *                              special lock handles are fine.
    305  * @param   phVfsFss            Where to return the new handle.
     305 * @param   phVfsObj            Where to return the new handle.
    306306 * @param   ppvInstance         Where to return the pointer to the instance data
    307307 *                              (size is @a cbInstance).
    … …  
    956956 *
    957957 * @returns IPRT status code.
    958  * @param   pvThis      The implementation specific file data.
    959958 * @param   fEvents     The events to poll for (RTPOLL_EVT_XXX).
    960959 * @param   cMillies    How long to wait for event to eventuate.

  • trunk/src/VBox/Runtime/Doxyfile

    r57926 r57944  
    12201220    DECL_FORCE_INLINE(type)=DECLINLINE(type) \
    12211221    DECL_NO_INLINE(type)=type \
     1222    DECLCALLBACK(type)=type \
    12221223    \
    12231224    AssertCompile(expr) \
    … …  
    12611262    DECLASM \
    12621263    DECLASMTYPE \
    1263     DECLCALLBACK \
    12641264    DECLCALLBACKMEMBER \
    12651265    DECLHCCALLBACKMEMBER \

  • trunk/src/VBox/Runtime/Makefile.kmk

    r57916 r57944  
    27312731        $(APPEND) [email protected] "INCLUDE_FILE_PATTERNS = *.cpp.h"
    27322732        $(APPEND) [email protected] "PREDEFINED += $(ARCH_BITS_DEFS)"
     2733        $(APPEND) [email protected] 'EXCLUDE = '\
     2734                '$(VBOX_PATH_RUNTIME_SRC)/common/string/unidata-flags.cpp' \
     2735        '$(VBOX_PATH_RUNTIME_SRC)/common/string/unidata-lower.cpp' \
     2736        '$(VBOX_PATH_RUNTIME_SRC)/common/string/unidata-upper.cpp'
    27332737        $(APPEND) [email protected]
    27342738        $(APPEND) [email protected] "INPUT = $(IPRT_DOXYFILE_INPUT)"

  • trunk/src/VBox/Runtime/common/dbg/dbgcfg.cpp

    r57358 r57944  
    451451 *                              directory.  RTPATH_MAX in size.
    452452 * @param   pszSubDir           The sub directory to append.
     453 * @param   pszSuffix           The suffix to append.
    453454 * @param   fCaseInsensitive    Whether case insensitive searching is required.
    454455 */
    … …  
    568569
    569570static int rtDbgCfgTryOpenDir(PRTDBGCFGINT pThis, char *pszPath, PRTPATHSPLIT pSplitFn, uint32_t fFlags,
    570                               PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
     571                              PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
    571572{
    572573    int rcRet = VWRN_NOT_FOUND;
    … …  
    736737                                      const char *pszCacheSubDir, const char *pszUuidMappingSubDir,
    737738                                      PRTPATHSPLIT pSplitFn, const char *pszCacheSuffix, uint32_t fFlags,
    738                                       PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
     739                                      PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
    739740{
    740741#ifdef IPRT_WITH_HTTP
    … …  
    888889                                const char *pszCacheSubDir, const char *pszUuidMappingSubDir,
    889890                                PCRTPATHSPLIT pSplitFn, const char *pszCacheSuffix, uint32_t fFlags,
    890                                 PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
     891                                PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
    891892{
    892893    Assert(pszPath[cchCachePath] == '\0');
    … …  
    977978static int rtDbgCfgTryOpenList(PRTDBGCFGINT pThis, PRTLISTANCHOR pList, PRTPATHSPLIT pSplitFn, const char *pszCacheSubDir,
    978979                               const char *pszUuidMappingSubDir, uint32_t fFlags, char *pszPath,
    979                                PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
     980                               PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
    980981{
    981982    int rcRet = VWRN_NOT_FOUND;
    … …  
    11441145static int rtDbgCfgOpenWithSubDir(RTDBGCFG hDbgCfg, const char *pszFilename, const char *pszCacheSubDir,
    11451146                                  const char *pszUuidMappingSubDir, uint32_t fFlags,
    1146                                   PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
     1147                                  PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
    11471148{
    11481149    int rcRet = VINF_SUCCESS;
    … …  
    12711272
    12721273RTDECL(int) RTDbgCfgOpenPeImage(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t cbImage, uint32_t uTimestamp,
    1273                                 PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
     1274                                PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
    12741275{
    12751276    char szSubDir[32];
    … …  
    12831284
    12841285RTDECL(int) RTDbgCfgOpenPdb70(RTDBGCFG hDbgCfg, const char *pszFilename, PCRTUUID pUuid, uint32_t uAge,
    1285                               PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
     1286                              PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
    12861287{
    12871288    char szSubDir[64];
    … …  
    13121313
    13131314RTDECL(int) RTDbgCfgOpenPdb20(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t cbImage, uint32_t uTimestamp, uint32_t uAge,
    1314                               PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
     1315                              PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
    13151316{
    13161317    /** @todo test this! */
    … …  
    13251326
    13261327RTDECL(int) RTDbgCfgOpenDbg(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t cbImage, uint32_t uTimestamp,
    1327                             PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
     1328                            PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
    13281329{
    13291330    char szSubDir[32];
    … …  
    13371338
    13381339RTDECL(int) RTDbgCfgOpenDwo(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t uCrc32,
    1339                             PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
     1340                            PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
    13401341{
    13411342    char szSubDir[32];
    … …  
    13611362static int rtDbgCfgTryOpenDsymBundleInDir(PRTDBGCFGINT pThis, char *pszPath, PRTPATHSPLIT pSplitFn,
    13621363                                          const char * const *papszSuffixes, uint32_t fFlags,
    1363                                           PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
     1364                                          PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
    13641365{
    13651366    int rcRet = VWRN_NOT_FOUND;
    … …  
    14501451                                       const char *pszCacheSuffix, const char *pszUuidMappingSubDir,
    14511452                                       uint32_t fFlags, char *pszPath,
    1452                                        PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
     1453                                       PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
    14531454{
    14541455    int rcRet = VWRN_NOT_FOUND;
    … …  
    16431644                                  const char *pszBundleSubDir, PCRTUUID pUuid, const char *pszUuidMapDirName,
    16441645                                  const char *pszCacheSuffix, bool fOpenImage,
    1645                                   PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
     1646                                  PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
    16461647{
    16471648    /*
    … …  
    17851786
    17861787RTDECL(int) RTDbgCfgOpenDsymBundle(RTDBGCFG hDbgCfg, const char *pszImage, PCRTUUID pUuid,
    1787                                    PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
     1788                                   PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
    17881789{
    17891790    return rtDbgCfgOpenBundleFile(hDbgCfg, pszImage, g_apszDSymBundleSuffixes,
    … …  
    17951796
    17961797RTDECL(int) RTDbgCfgOpenMachOImage(RTDBGCFG hDbgCfg, const char *pszImage, PCRTUUID pUuid,
    1797                                    PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
     1798                                   PFNRTDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2)
    17981799{
    17991800    return rtDbgCfgOpenBundleFile(hDbgCfg, pszImage, g_apszBundleSuffixes,
    … …  
    19331934 * @param   enmOp               The change operation.
    19341935 * @param   pszValue            The input value.
    1935  * @param   pszMnemonics        The mnemonics map for this value.
     1936 * @param   paMnemonics         The mnemonics map for this value.
    19361937 * @param   puValue             The value to change.
    19371938 */
    … …  
    20872088 *
    20882089 * @returns VINF_SUCCESS, VERR_BUFFER_OVERFLOW.
    2089  * @param   pThis               The config instance.
     2090 * @param   hDbgCfg             The config instance handle.
    20902091 * @param   pList               The string list anchor.
    20912092 * @param   pszValue            The output buffer.
    … …  
    21262127 *
    21272128 * @returns VINF_SUCCESS, VERR_BUFFER_OVERFLOW.
    2128  * @param   pThis               The config instance.
     2129 * @param   hDbgCfg             The config instance handle.
    21292130 * @param   uValue              The value to query.
    2130  * @param   pszMnemonics        The mnemonics map for this value.
     2131 * @param   paMnemonics         The mnemonics map for this value.
    21312132 * @param   pszValue            The output buffer.
    21322133 * @param   cbValue             The size of the output buffer.

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

    r57358 r57944  
    870870
    871871/** @callback_method_impl{FNDBGMODCVSUBSECTCALLBACK,
    872  * Parses kCvSst_GlobalPub, kCvSst_GlobalSym and kCvSst_StaticSym subsections,
     872 * Parses kCvSst_GlobalPub\, kCvSst_GlobalSym and kCvSst_StaticSym subsections\,
    873873 * adding symbols it finds to the container.} */
    874874static DECLCALLBACK(int)
    … …  
    898898
    899899/** @callback_method_impl{FNDBGMODCVSUBSECTCALLBACK,
    900  * Parses kCvSst_Module subsection, storing the debugging style in pThis.} */
     900 * Parses kCvSst_Module subsection\, storing the debugging style in pThis.} */
    901901static DECLCALLBACK(int)
    902902rtDbgModCvSs_Module(PRTDBGMODCV pThis, void const *pvSubSect, size_t cbSubSect, PCRTCVDIRENT32 pDirEnt)
    … …  
    929929
    930930/** @callback_method_impl{FNDBGMODCVSUBSECTCALLBACK,
    931  * Parses kCvSst_Symbols, kCvSst_PublicSym and kCvSst_AlignSym subsections,
     931 * Parses kCvSst_Symbols\, kCvSst_PublicSym and kCvSst_AlignSym subsections\,
    932932 * adding symbols it finds to the container.} */
    933933static DECLCALLBACK(int)
    … …  
    21822182
    21832183
    2184 /** @callback_method_impl{FNRTLDRENUMSEGS,
    2185  * Used to add segments from the image.}  */
     2184/**
     2185 * @callback_method_impl{FNRTLDRENUMSEGS, Used to add segments from the image}
     2186 */
    21862187static DECLCALLBACK(int) rtDbgModCvAddSegmentsCallback(RTLDRMOD hLdrMod, PCRTLDRSEG pSeg, void *pvUser)
    21872188{
    … …  
    23732374 * @param   pDbgMod             The debug module instance.  On success pvDbgPriv
    23742375 *                              will point to a valid RTDBGMODCV.
     2376 * @param   enmFileType         The kind of file this is we're probing.
    23752377 * @param   hFile               The file with debug info in it.
    23762378 * @param   off                 The offset where to expect CV debug info.
    23772379 * @param   cb                  The number of bytes of debug info.
    2378  * @param   enmArch             The desired image architecture.
    23792380 * @param   pszFilename         The path to the file (for logging).
    23802381 */

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

    r57358 r57944  
    591591 * @param   pDesc           The attribute descriptor.
    592592 * @param   uForm           The data form.
    593  * @param   pDataCursor     The cursor to read data from.
     593 * @param   pCursor         The cursor to read data from.
    594594 */
    595595typedef DECLCALLBACK(int) FNRTDWARFATTRDECODER(PRTDWARFDIE pDie, uint8_t *pbMember, PCRTDWARFATTRDESC pDesc,
    … …  
    19761976 *          uErrValue is returned.
    19771977 * @param   pCursor             The cursor.
    1978  * @param   uErrValue           What to return on error.
     1978 * @param   iErrValue           What to return on error.
    19791979 */
    19801980static int8_t rtDwarfCursor_GetSByte(PRTDWARFCURSOR pCursor, int8_t iErrValue)

  • trunk/src/VBox/Runtime/common/dbg/dbgmodexports.cpp

    r57358 r57944  
    5656
    5757/** @callback_method_impl{FNRTLDRENUMSYMS,
    58  *  Copies the symbols over into the container.} */
     58 *      Copies the symbols over into the container} */
    5959static DECLCALLBACK(int) rtDbgModExportsAddSymbolCallback(RTLDRMOD hLdrMod, const char *pszSymbol, unsigned uSymbol,
    6060                                                          RTLDRADDR Value, void *pvUser)
    … …  
    7676
    7777/** @callback_method_impl{FNRTLDRENUMSEGS,
    78  *  Copies the segments over into the container.} */
     78 *      Copies the segments over into the container} */
    7979static DECLCALLBACK(int) rtDbgModExportsAddSegmentsCallback(RTLDRMOD hLdrMod, PCRTLDRSEG pSeg, void *pvUser)
    8080{

  • trunk/src/VBox/Runtime/common/dbg/dbgmodldr.cpp

    r57358 r57944  
    124124
    125125
    126 /** @interface_method_impl{RTDBGMODVTIMG,pfnGetLoadedSize} */
    127 static DECLCALLBACK(RTUINTPTR) rtDbgModLdr_GetLoadedSize(PRTDBGMODINT pMod)
     126/** @interface_method_impl{RTDBGMODVTIMG,pfnImageSize} */
     127static DECLCALLBACK(RTUINTPTR) rtDbgModLdr_ImageSize(PRTDBGMODINT pMod)
    128128{
    129129    PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
    … …  
    216216    /*.pfnEnumSegments = */             rtDbgModLdr_EnumSegments,
    217217    /*.pfnEnumSymbols = */              rtDbgModLdr_EnumSymbols,
    218     /*.pfnGetLoadedSize = */            rtDbgModLdr_GetLoadedSize,
     218    /*.pfnImageSize = */                rtDbgModLdr_ImageSize,
    219219    /*.pfnLinkAddressToSegOffset = */   rtDbgModLdr_LinkAddressToSegOffset,
    220220    /*.pfnRvaToSegOffset= */            rtDbgModLdr_RvaToSegOffset,

  • trunk/src/VBox/Runtime/common/math/bignum.cpp

    r57358 r57944  
    20762076 * @param   pauDividendJ    Pointer to the j-th (normalized) dividend element.
    20772077 *                          Will access up to two elements prior to this.
    2078  * @param   uDivZ           The last element in the (normalized) divisor.
    2079  * @param   uDivY           The penultimate element in the (normalized) divisor.
     2078 * @param   pauDivisor      The last element in the (normalized) divisor.
     2079 * @param   cDivisor        The penultimate element in the (normalized) divisor.
    20802080 */
    20812081DECLINLINE(void) rtBigNumKnuthD6_AddBack(PRTBIGNUMELEMENT pauDividendJ, PRTBIGNUMELEMENT pauDivisor, uint32_t cDivisor)

  • trunk/src/VBox/Runtime/common/misc/aiomgr.cpp

    r57358 r57944  
    244244 * @returns TRUE if there are still requests pending on the current manager for this endpoint.
    245245 *          FALSE otherwise.
    246  * @param   pEndpointRemove    The endpoint to remove.
     246 * @param   pFile           The endpoint to remove.
    247247 */
    248248static bool rtAioMgrFileRemove(PRTAIOMGRFILEINT pFile)

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

    r57358 r57944  
    11271127 *          first retainer.  NIL_RTLOCKVALCLASS if we run into trouble.
    11281128 *
    1129  * @param   pszFile             The source position of the call, file.
    1130  * @param   iLine               The source position of the call, line.
    1131  * @param   pszFunction         The source position of the call, function.
     1129 * @param   SRC_POS             The source position where call is being made from.
     1130 *                              Use RT_SRC_POS when possible.  Optional.
    11321131 * @param   pszNameFmt          Class name format string, optional (NULL).  Max
    11331132 *                              length is 32 bytes.

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

    r57865 r57944  
    238238
    239239
     240/**
     241 * Matching variable lookup table.
     242 * Currently so small we don't bother sorting it and doing binary lookups.
     243 */
     244typedef struct RTPATHMATCHVAR
     245{
     246    /** The variable name. */
     247    const char     *pszName;
     248    /** The variable name length. */
     249    uint16_t        cchName;
     250    /** Only available as the verify first component.  */
     251    bool            fFirstOnly;
     252
     253    /**
     254     * Queries a given variable value.
     255     *
     256     * @returns IPRT status code.
     257     * @retval  VERR_BUFFER_OVERFLOW
     258     * @retval  VERR_TRY_AGAIN if the caller should skip this value item and try the
     259     *          next one instead (e.g. env var not present).
     260     * @retval  VINF_EOF when retrieving the last one, if possible.
     261     * @retval  VERR_EOF when @a iItem is past the item space.
     262     *
     263     * @param   iItem       The variable value item to retrieve. (A variable may
     264     *                      have more than one value, e.g. 'BothProgramFile' on a
     265     *                      64-bit system or 'Path'.)
     266     * @param   pszBuf      Where to return the value.
     267     * @param   cbBuf       The buffer size.
     268     * @param   pcchValue   Where to return the length of the return string.
     269     * @param   pCache      Pointer to the path matching cache.  May speed up
     270     *                      enumerating PATH items and similar.
     271     */
     272    DECLCALLBACKMEMBER(int, pfnQuery)(uint32_t iItem, char *pszBuf, size_t cbBuf, size_t *pcchValue, PRTPATHMATCHCACHE pCache);
     273
     274    /**
     275     * Matching method, optional.
     276     *
     277     * @returns IPRT status code.
     278     * @retval  VINF_SUCCESS on match.
     279     * @retval  VERR_MISMATCH on mismatch.
     280     *
     281     * @param   pszMatch    String to match with (not terminated).
     282     * @param   cchMatch    The length of what we match with.
     283     * @param   fIgnoreCase Whether to ignore case or not when comparing.
     284     * @param   pcchMatched Where to return the length of the match (value length).
     285     */
     286    DECLCALLBACKMEMBER(int, pfnMatch)(const char *pchMatch, size_t cchMatch, bool fIgnoreCase, size_t *pcchMatched);
     287
     288} RTPATHMATCHVAR;
     289
     290
    240291/*********************************************************************************************************************************
    241292*   Internal Functions                                                                                                           *
    … …  
    400451
    401452/**
    402  * @interface_method_impl{RTPATHMATCHVAR::pfnQuery, Enumerates the PATH}.
     453 * @interface_method_impl{RTPATHMATCHVAR,pfnQuery, Enumerates the PATH}.
    403454 */
    404455static DECLCALLBACK(int) rtPathVarQuery_Path(uint32_t iItem, char *pszBuf, size_t cbBuf, size_t *pcchValue,
    … …  
    488539#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
    489540/**
    490  * @interface_method_impl{RTPATHMATCHVAR::pfnQuery,
     541 * @interface_method_impl{RTPATHMATCHVAR,pfnQuery,
    491542 *      The system drive letter + colon.}.
    492543 */
    … …  
    540591#ifdef RT_OS_WINDOWS
    541592/**
    542  * @interface_method_impl{RTPATHMATCHVAR::pfnQuery,
     593 * @interface_method_impl{RTPATHMATCHVAR,pfnQuery,
    543594 *      The system root directory (C:\Windows).}.
    544595 */
    … …  
    565616
    566617/**
    567  * Matching variable lookup table.
    568  * Currently so small we don't bother sorting it and doing binary lookups.
    569  */
    570 static struct RTPATHMATCHVAR
    571 {
    572     /** The variable name. */
    573     const char     *pszName;
    574     /** The variable name length. */
    575     uint16_t        cchName;
    576     /** Only available as the verify first component.  */
    577     bool            fFirstOnly;
    578 
    579     /**
    580      * Queries a given variable value.
    581      *
    582      * @returns IPRT status code.
    583      * @retval  VERR_BUFFER_OVERFLOW
    584      * @retval  VERR_TRY_AGAIN if the caller should skip this value item and try the
    585      *          next one instead (e.g. env var not present).
    586      * @retval  VINF_EOF when retrieving the last one, if possible.
    587      * @retval  VERR_EOF when @a iItem is past the item space.
    588      *
    589      * @param   iItem       The variable value item to retrieve. (A variable may
    590      *                      have more than one value, e.g. 'BothProgramFile' on a
    591      *                      64-bit system or 'Path'.)
    592      * @param   pszBuf      Where to return the value.
    593      * @param   cbBuf       The buffer size.
    594      * @param   pcchValue   Where to return the length of the return string.
    595      * @param   pCache      Pointer to the path matching cache.  May speed up
    596      *                      enumerating PATH items and similar.
    597      */
    598     DECLCALLBACKMEMBER(int, pfnQuery)(uint32_t iItem, char *pszBuf, size_t cbBuf, size_t *pcchValue, PRTPATHMATCHCACHE pCache);
    599 
    600     /**
    601      * Matching method, optional.
    602      *
    603      * @returns IPRT status code.
    604      * @retval  VINF_SUCCESS on match.
    605      * @retval  VERR_MISMATCH on mismatch.
    606      *
    607      * @param   pszMatch    String to match with (not terminated).
    608      * @param   cchMatch    The length of what we match with.
    609      * @param   fIgnoreCase Whether to ignore case or not when comparing.
    610      * @param   pcchMatched Where to return the length of the match (value length).
    611      */
    612     DECLCALLBACKMEMBER(int, pfnMatch)(const char *pchMatch, size_t cchMatch, bool fIgnoreCase, size_t *pcchMatched);
    613 
    614 } const g_aVariables[] =
     618 *
     619 *
     620 * @author bird (9/29/2015)
     621 */
     622static RTPATHMATCHVAR const g_aVariables[] =
    615623{
    616624    { RT_STR_TUPLE("Arch"),                     false,  rtPathVarQuery_Arch, rtPathVarMatch_Arch },

  • trunk/src/VBox/Runtime/common/string/strformat.cpp

    r57358 r57944  
    555555                            while (cchStr-- > 0)
    556556                            {
    557 /**@todo #ifndef IN_RC*/
     557/**@todo \#ifndef IN_RC*/
    558558#ifdef IN_RING3
    559559                                RTUNICP Cp;
    … …  
    589589                            while (cchStr-- > 0)
    590590                            {
    591 /**@todo #ifndef IN_RC*/
     591/**@todo \#ifndef IN_RC*/
    592592#ifdef IN_RING3
    593593                                char szUtf8[8]; /* Cp=0x7fffffff -> 6 bytes. */

  • trunk/src/VBox/Runtime/common/string/uniread.cpp

    r57358 r57944  
    712712 * Applies a property to a code point.
    713713 *
    714  * @param   StartCP     The code point.
    715  * @param   pszProperty The property name.
     714 * @param   StartCP         The code point.
     715 * @param   pszProperty     The property name.
     716 * @param   pszNextField    The next field.
    716717 */
    717718static void ApplyProperty(RTUNICP StartCP, const char *pszProperty, char *pszNextField)

  • trunk/src/VBox/Runtime/common/string/utf-8.cpp

    r57358 r57944  
    870870 *
    871871 * @returns iprt status code.
    872  * @param   psz         The Latin-1 string.
     872 * @param   pszIn       The Latin-1 string.
    873873 * @param   cchIn       The number of characters to process from psz. The recoding
    874874 *                      will stop when cch or '\\0' is reached.

  • trunk/src/VBox/Runtime/common/time/timesup.cpp

    r57358 r57944  
    112112
    113113/**
    114  * @interface_method_impl{RTTIMENANOTSDATA, pfnBad}
     114 * @interface_method_impl{RTTIMENANOTSDATA,pfnBad}
    115115 */
    116116static DECLCALLBACK(void) rtTimeNanoTSInternalBitch(PRTTIMENANOTSDATA pData, uint64_t u64NanoTS, uint64_t u64DeltaPrev,
    … …  
    127127
    128128/**
    129  * @interface_method_impl{RTTIMENANOTSDATA, pfnBadCpuIndex}
     129 * @interface_method_impl{RTTIMENANOTSDATA,pfnBadCpuIndex}
    130130 */
    131131static DECLCALLBACK(uint64_t) rtTimeNanoTSInternalBadCpuIndex(PRTTIMENANOTSDATA pData, uint16_t idApic,

  • trunk/src/VBox/Runtime/generic/http-curl.cpp

    r57905 r57944  
    177177*   Defined Constants And Macros                                                                                                 *
    178178*********************************************************************************************************************************/
    179 /** @def RTHTTP_MAX_MEM_DOWNLOAD
     179/** @def RTHTTP_MAX_MEM_DOWNLOAD_SIZE
    180180 * The max size we are allowed to download to a memory buffer.
    181181 *
    … …  
    598598 * Configures a proxy given a "URL" like specification.
    599599 *
    600  * Format is [<scheme>"://"][<userid>[@<password>]:]<server>[":"<port>].
     600 * Format is:
     601 * <pre> [<scheme>"://"][<userid>[@<password>]:]<server>[":"<port>] </pre>
    601602 *
    602603 * @returns IPRT status code.

  • trunk/src/VBox/Runtime/include/internal/dbgmod.h

    r56290 r57944  
    233233     * @returns IPRT status code.
    234234     * @param   pMod            Pointer to the module structure.
    235      * @param   enmLdrProp      The property to query.
     235     * @param   enmProp         The property to query.
    236236     * @param   pvBuf           Pointer to the return buffer.
    237237     * @param   cbBuf           The size of the return buffer.
    … …  
    524524 * @returns IPRT status code. On success the necessary method tables should be
    525525 *          installed in @a pMod.
    526  * @param   pMod            Pointer to the debug module structure.
     526 * @param   pDbgMod         Pointer to the debug module structure.
    527527 * @param   pDeferred       The deferred load data.
    528528 */
    529 typedef DECLCALLBACK(int) FNRTDBGMODDEFERRED(PRTDBGMODINT pMod, struct RTDBGMODDEFERRED *pDeferred);
     529typedef DECLCALLBACK(int) FNRTDBGMODDEFERRED(PRTDBGMODINT pDbgMod, struct RTDBGMODDEFERRED *pDeferred);
    530530/** Pointer to a deferred loading callback. */
    531531typedef FNRTDBGMODDEFERRED *PFNRTDBGMODDEFERRED;

  • trunk/src/VBox/Runtime/r3/solaris/coredumper-solaris.cpp

    r57476 r57944  
    399399 *
    400400 * @param pSolCore          Pointer to the core object.
    401  * @param pszFileFmt        Only the name of the file to read from (/proc/<pid> will be prepended)
     401 * @param pszProcFileName   Only the name of the file to read from
     402 *                          (/proc/\<pid\> will be prepended)
    402403 * @param ppv               Where to store the allocated buffer.
    403404 * @param pcb               Where to store size of the buffer.
    … …  
    513514 * Read process credential information (format prcred_t + array of guid_t)
    514515 *
     516 * @return IPRT status code.
    515517 * @param pSolCore          Pointer to the core object.
    516518 *
    517519 * @remarks Should not be called before successful call to @see AllocMemoryArea()
    518  * @return IPRT status code.
    519520 */
    520521static int ProcReadCred(PRTSOLCORE pSolCore)
    … …  
    530531 * Read process privilege information (format prpriv_t + array of priv_chunk_t)
    531532 *
     533 * @return IPRT status code.
    532534 * @param pSolCore          Pointer to the core object.
    533535 *
    534536 * @remarks Should not be called before successful call to @see AllocMemoryArea()
    535  * @return IPRT status code.
    536537 */
    537538static int ProcReadPriv(PRTSOLCORE pSolCore)
    … …  
    556557 * Read process LDT information (format array of struct ssd) from /proc.
    557558 *
    558  * @param pSolProc         Pointer to the core object.
     559 * @return  IPRT status code.
     560 * @param   pSolCore        Pointer to the core object.
    559561 *
    560562 * @remarks Should not be called before successful call to @see AllocMemoryArea()
    561  * @return IPRT status code.
    562563 */
    563564static int ProcReadLdt(PRTSOLCORE pSolCore)
    … …  
    573574 * Read process auxiliary vectors (format auxv_t) for the process.
    574575 *
     576 * @return IPRT status code.
    575577 * @param pSolCore          Pointer to the core object.
    576578 *
    577579 * @remarks Should not be called before successful call to @see AllocMemoryArea()
    578  * @return IPRT status code.
    579580 */
    580581static int ProcReadAuxVecs(PRTSOLCORE pSolCore)
    … …  
    663664 * Read the process mappings (format prmap_t array).
    664665 *
     666 * @return IPRT status code.
    665667 * @param   pSolCore            Pointer to the core object.
    666668 *
    667669 * @remarks Should not be called before successful call to @see AllocMemoryArea()
    668  * @return IPRT status code.
    669670 */
    670671static int ProcReadMappings(PRTSOLCORE pSolCore)
    … …  
    801802 * Reads the thread information for all threads in the process.
    802803 *
     804 * @return IPRT status code.
    803805 * @param pSolCore          Pointer to the core object.
    804806 *
    805807 * @remarks Should not be called before successful call to @see AllocMemoryArea()
    806  * @return IPRT status code.
    807808 */
    808809static int ProcReadThreads(PRTSOLCORE pSolCore)
    … …  
    18431844 * to be in suspended state (i.e. called after CreateCore).
    18441845 *
     1846 * @return IPRT status.
    18451847 * @param pSolCore          Pointer to the core object.
    18461848 * @param pfnWriter         Pointer to the writer function to override default writer (NULL uses default).
    … …  
    18481850 * @remarks Resumes all suspended threads, unless it's an invalid core. This
    18491851 *          function must be called only -after- rtCoreDumperCreateCore().
    1850  * @return IPRT status.
    18511852 */
    18521853static int rtCoreDumperWriteCore(PRTSOLCORE pSolCore, PFNRTCOREWRITER pfnWriter)
    … …  
    19131914 * are ultimately resumed en-masse) already suspended while calling this function.
    19141915 *
     1916 * @return IPRT status code.
    19151917 * @param pSolCore          Pointer to a core object.
    19161918 * @param pContext          Pointer to the caller context thread.
    … …  
    19191921 *
    19201922 * @remarks Halts all threads.
    1921  * @return IPRT status code.
    19221923 */
    19231924static int rtCoreDumperCreateCore(PRTSOLCORE pSolCore, ucontext_t *pContext, const char *pszCoreFilePath)

  • trunk/src/VBox/Runtime/r3/stream.cpp

    r57358 r57944  
    9090    /** Whether the stream was opened in binary mode. */
    9191    bool                fBinary;
    92     /** Whether to recheck the stream mode before writing.. */
     92    /** Whether to recheck the stream mode before writing. */
    9393    bool                fRecheckMode;
    9494#ifndef HAVE_FWRITE_UNLOCKED

  • trunk/src/VBox/Runtime/r3/tcp.cpp

    r57358 r57944  
    156156 * @returns The old handle value.
    157157 * @param   phSock          The socket handle variable to update.
    158  * @param   hSock           The new socket handle value.
     158 * @param   hNew            The new socket handle value.
    159159 */
    160160DECLINLINE(RTSOCKET) rtTcpAtomicXchgSock(RTSOCKET volatile *phSock, const RTSOCKET hNew)

  • trunk/src/VBox/Runtime/r3/test.cpp

    r57358 r57944  
    427427
    428428
    429 RTR3DECL(RTEXITCODE) RTTestInitExAndCreate(int cArgs, char ***papszArgs, uint32_t fRtInit, const char *pszTest, PRTTEST phTest)
     429RTR3DECL(RTEXITCODE) RTTestInitExAndCreate(int cArgs, char ***ppapszArgs, uint32_t fRtInit, const char *pszTest, PRTTEST phTest)
    430430{
    431431    int rc;
    432     if (cArgs <= 0 && papszArgs == NULL)
     432    if (cArgs <= 0 && ppapszArgs == NULL)
    433433        rc = RTR3InitExeNoArguments(fRtInit);
    434434    else
    435         rc = RTR3InitExe(cArgs, papszArgs, fRtInit);
     435        rc = RTR3InitExe(cArgs, ppapszArgs, fRtInit);
    436436    if (RT_FAILURE(rc))
    437437    {

  • trunk/src/VBox/Runtime/r3/udp.cpp

    r57358 r57944  
    128128 * @returns The old handle value.
    129129 * @param   phSock          The socket handle variable to update.
    130  * @param   hSock           The new socket handle value.
     130 * @param   hNew            The new socket handle value.
    131131 */
    132132DECLINLINE(RTSOCKET) rtUdpAtomicXchgSock(RTSOCKET volatile *phSock, const RTSOCKET hNew)

  • trunk/src/VBox/Runtime/r3/xml.cpp

    r57358 r57944  
    14401440 * that was either created or changed.
    14411441 *
    1442  * @param pcszName
    1443  * @param i
     1442 * @param   pcszName    The attribute name.
     1443 * @param   f           The attribute value.
    14441444 * @return
    14451445 */
    … …  
    14581458 * @param   pListAnchor Pointer to the m_children member of the parent.  NULL
    14591459 *                      for the root node.
    1460  * @param   pLibNode    Pointer to the libxml2 node structure.
     1460 * @param   pLibAttr    Pointer to the libxml2 attribute structure.
    14611461 */
    14621462AttributeNode::AttributeNode(const ElementNode *pElmRoot,
Note: See TracChangeset for help on using the changeset viewer.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette