VirtualBox

Changeset 57926 in vbox for trunk/src/VBox/Runtime


Ignore:
Timestamp:
Sep 28, 2015 2:05:58 PM (9 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
102898
Message:

IPRT: Doxygen clenaups (mostly).

Location:
trunk/src/VBox/Runtime
Files:
11 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/Runtime/Doxyfile

    r36507 r57926  
    205205\
    206206Implements the callback \link \1 \1 "
     207
     208# bugref - xTracker bug reference, takes one to four bug numbers.
     209ALIASES               += bugref{1}="https://xtracker.innotek.de/index.php?bug=\1"
     210ALIASES               += bugref{2}="https://xtracker.innotek.de/index.php?bug=\1, \
     211https://xtracker.innotek.de/index.php?bug=\2"
     212ALIASES               += bugref{3}="https://xtracker.innotek.de/index.php?bug=\1, \
     213https://xtracker.innotek.de/index.php?bug=\2, \
     214https://xtracker.innotek.de/index.php?bug=\3"
     215ALIASES               += bugref{4}="https://xtracker.innotek.de/index.php?bug=\1, \
     216https://xtracker.innotek.de/index.php?bug=\2, \
     217https://xtracker.innotek.de/index.php?bug=\3, \
     218https://xtracker.innotek.de/index.php?bug=\4"
     219
     220# ticketref - Track ticket reference, takes one to four ticket numbers.
     221ALIASES               += ticketref{1}="http://www.virtualbox.org/ticket/\1"
     222ALIASES               += ticketref{2}="http://www.virtualbox.org/ticket/\1, \
     223http://www.virtualbox.org/ticket/\2"
     224ALIASES               += ticketref{3}="http://www.virtualbox.org/ticket/\1, \
     225http://www.virtualbox.org/ticket/\2, \
     226http://www.virtualbox.org/ticket/\3"
     227ALIASES               += ticketref{4}="http://www.virtualbox.org/ticket/\1, \
     228http://www.virtualbox.org/ticket/\2, \
     229http://www.virtualbox.org/ticket/\3, \
     230http://www.virtualbox.org/ticket/\4"
     231
    207232
    208233# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
    … …  
    11941219    "DECLINLINE(type)=inline type" \
    11951220    DECL_FORCE_INLINE(type)=DECLINLINE(type) \
     1221    DECL_NO_INLINE(type)=type \
    11961222    \
    11971223    AssertCompile(expr) \
    … …  
    12031229    AssertCompile2MemberOffsets(a,b,c) \
    12041230    \
     1231    RT_SRC_POS=1 \
     1232    RT_SRC_POS_ARGS=SRC_POS \
     1233    "RT_SRC_POS_DECL=int SRC_POS" \
     1234    \
     1235    RT_IPRT_FORMAT_ATTR(a,b)= \
     1236    RT_IPRT_FORMAT_ATTR_MAYBE_NULL(a,b)= \
     1237    RT_NO_THROW_PROTO=
    12051238
    12061239# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
    … …  
    12451278    CTXMID \
    12461279    OTHERCTXMID \
    1247     \
    1248     RT_SRC_POS \
    1249     RT_SRC_POS_ARGS \
    1250     RT_SRC_POS_DECL
    12511280
    12521281

  • trunk/src/VBox/Runtime/common/asn1/asn1-basics.cpp

    r57358 r57926  
    334334 */
    335335
    336 RTDECL(void) RTAsn1VtDelete(PRTASN1CORE pAsn1Core)
    337 {
    338     if (pAsn1Core)
    339     {
    340         PCRTASN1COREVTABLE pOps = pAsn1Core->pOps;
     336RTDECL(void) RTAsn1VtDelete(PRTASN1CORE pThisCore)
     337{
     338    if (pThisCore)
     339    {
     340        PCRTASN1COREVTABLE pOps = pThisCore->pOps;
    341341        if (pOps)
    342             pOps->pfnDtor(pAsn1Core);
     342            pOps->pfnDtor(pThisCore);
    343343    }
    344344}
    … …  
    355355
    356356
    357 static DECLCALLBACK(int) rtAsn1VtDeepEnumDepthFirst(PRTASN1CORE pAsn1Core, const char *pszName, uint32_t uDepth, void *pvUser)
    358 {
    359     AssertReturn(pAsn1Core, VINF_SUCCESS);
    360 
    361     if (pAsn1Core->pOps && pAsn1Core->pOps->pfnEnum)
    362     {
    363         int rc = pAsn1Core->pOps->pfnEnum(pAsn1Core, rtAsn1VtDeepEnumDepthFirst, uDepth, pvUser);
     357static DECLCALLBACK(int) rtAsn1VtDeepEnumDepthFirst(PRTASN1CORE pThisCore, const char *pszName, uint32_t uDepth, void *pvUser)
     358{
     359    AssertReturn(pThisCore, VINF_SUCCESS);
     360
     361    if (pThisCore->pOps && pThisCore->pOps->pfnEnum)
     362    {
     363        int rc = pThisCore->pOps->pfnEnum(pThisCore, rtAsn1VtDeepEnumDepthFirst, uDepth, pvUser);
    364364        if (rc != VINF_SUCCESS)
    365365            return rc;
    … …  
    367367
    368368    RTASN1DEEPENUMCTX *pCtx = (RTASN1DEEPENUMCTX *)pvUser;
    369     return pCtx->pfnCallback(pAsn1Core, pszName, uDepth, pCtx->pvUser);
    370 }
    371 
    372 
    373 static DECLCALLBACK(int) rtAsn1VtDeepEnumDepthLast(PRTASN1CORE pAsn1Core, const char *pszName, uint32_t uDepth, void *pvUser)
    374 {
    375     AssertReturn(pAsn1Core, VINF_SUCCESS);
     369    return pCtx->pfnCallback(pThisCore, pszName, uDepth, pCtx->pvUser);
     370}
     371
     372
     373static DECLCALLBACK(int) rtAsn1VtDeepEnumDepthLast(PRTASN1CORE pThisCore, const char *pszName, uint32_t uDepth, void *pvUser)
     374{
     375    AssertReturn(pThisCore, VINF_SUCCESS);
    376376
    377377    RTASN1DEEPENUMCTX *pCtx = (RTASN1DEEPENUMCTX *)pvUser;
    378     int rc = pCtx->pfnCallback(pAsn1Core, pszName, uDepth, pCtx->pvUser);
     378    int rc = pCtx->pfnCallback(pThisCore, pszName, uDepth, pCtx->pvUser);
    379379    if (rc == VINF_SUCCESS)
    380380    {
    381         if (pAsn1Core->pOps && pAsn1Core->pOps->pfnEnum)
    382             rc = pAsn1Core->pOps->pfnEnum(pAsn1Core, rtAsn1VtDeepEnumDepthFirst, uDepth, pvUser);
     381        if (pThisCore->pOps && pThisCore->pOps->pfnEnum)
     382            rc = pThisCore->pOps->pfnEnum(pThisCore, rtAsn1VtDeepEnumDepthFirst, uDepth, pvUser);
    383383    }
    384384    return rc;

  • trunk/src/VBox/Runtime/common/checksum/manifest2.cpp

    r57358 r57926  
    135135    const char * const *papszIgnoreEntries;
    136136    /** Name of attributes to ignore. */
    137     const char * const *papszIgnoreAttr;
     137    const char * const *papszIgnoreAttrs;
    138138    /** Flags governing the comparision. */
    139139    uint32_t            fFlags;
    … …  
    350350     * Ignore this entry?
    351351     */
    352     char const * const *ppsz = pEquals->papszIgnoreAttr;
     352    char const * const *ppsz = pEquals->papszIgnoreAttrs;
    353353    if (ppsz)
    354354    {
    … …  
    425425     * Ignore this entry?
    426426     */
    427     char const * const *ppsz = pEquals->papszIgnoreAttr;
     427    char const * const *ppsz = pEquals->papszIgnoreAttrs;
    428428    if (ppsz)
    429429    {
    … …  
    571571
    572572RTDECL(int) RTManifestEqualsEx(RTMANIFEST hManifest1, RTMANIFEST hManifest2, const char * const *papszIgnoreEntries,
    573                                const char * const *papszIgnoreAttr, uint32_t fFlags, char *pszError, size_t cbError)
     573                               const char * const *papszIgnoreAttrs, uint32_t fFlags, char *pszError, size_t cbError)
    574574{
    575575    /*
    … …  
    614614    Equals.fFlags               = fFlags;
    615615    Equals.papszIgnoreEntries   = papszIgnoreEntries;
    616     Equals.papszIgnoreAttr      = papszIgnoreAttr;
     616    Equals.papszIgnoreAttrs     = papszIgnoreAttrs;
    617617    Equals.pszError             = pszError;
    618618    Equals.cbError              = cbError;

  • trunk/src/VBox/Runtime/common/err/RTErrConvertFromErrno.cpp

    r57358 r57926  
    120120#endif
    121121#ifdef ENFILE
    122         case ENFILE:            return VERR_TOO_MANY_OPEN_FILES; /**@Todo fix duplicate error */
     122        case ENFILE:            return VERR_TOO_MANY_OPEN_FILES; /** @todo fix duplicate error */
    123123#endif
    124124#ifdef EMFILE

  • trunk/src/VBox/Runtime/common/err/errmsg.cpp

    r57358 r57926  
    4646static const RTSTATUSMSG  g_aStatusMsgs[] =
    4747{
    48 #ifndef IPRT_NO_ERROR_DATA
     48#if !defined(IPRT_NO_ERROR_DATA) && !defined(DOXYGEN_RUNNING)
    4949# include "errmsgdata.h"
    5050#else

  • trunk/src/VBox/Runtime/common/err/errmsgxpcom.cpp

    r57358 r57926  
    107107    MY_ERR("NS_SUCCESS_FILE_DIRECTORY_EMPTY",       "NS_SUCCESS_FILE_DIRECTORY_EMPTY",              UINT32_C(0x00520001)),
    108108
    109 #if defined(VBOX) && !defined(IN_GUEST)
     109#if defined(VBOX) && !defined(IN_GUEST) && !defined(DOXYGEN_RUNNING)
    110110# include "errmsgvboxcomdata.h"
    111111#endif

  • trunk/src/VBox/Runtime/r0drv/solaris/semeventwait-r0drv-solaris.h

    r56290 r57926  
    101101 * @param   fFlags              The wait flags.
    102102 * @param   uTimeout            The timeout.
    103  * @param   pWaitQueue          The wait queue head.
    104103 */
    105104DECLINLINE(int) rtR0SemSolWaitInit(PRTR0SEMSOLWAIT pWait, uint32_t fFlags, uint64_t uTimeout)

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

    r57358 r57926  
    369369 * rtR3Init worker.
    370370 */
    371 static int rtR3InitBody(uint32_t fFlags, int cArgs, char ***papszArgs, const char *pszProgramPath)
     371static int rtR3InitBody(uint32_t fFlags, int cArgs, char ***ppapszArgs, const char *pszProgramPath)
    372372{
    373373    /*
    … …  
    448448    AssertLogRelMsgRCReturn(rc, ("Failed to get executable directory path, rc=%Rrc!\n", rc), rc);
    449449
    450     rc = rtR3InitArgv(fFlags, cArgs, papszArgs);
     450    rc = rtR3InitArgv(fFlags, cArgs, ppapszArgs);
    451451    AssertLogRelMsgRCReturn(rc, ("Failed to convert the arguments, rc=%Rrc!\n", rc), rc);
    452452
    … …  
    550550 *                          out ourselves.
    551551 */
    552 static int rtR3Init(uint32_t fFlags, int cArgs, char ***papszArgs, const char *pszProgramPath)
     552static int rtR3Init(uint32_t fFlags, int cArgs, char ***ppapszArgs, const char *pszProgramPath)
    553553{
    554554    /* no entry log flow, because prefixes and thread may freak out. */
    … …  
    590590            rc = rtR3InitProgramPath(pszProgramPath);
    591591        if (RT_SUCCESS(rc))
    592             rc = rtR3InitArgv(fFlags, cArgs, papszArgs);
     592            rc = rtR3InitArgv(fFlags, cArgs, ppapszArgs);
    593593        return rc;
    594594    }
    … …  
    598598     * Do the initialization.
    599599     */
    600     int rc = rtR3InitBody(fFlags, cArgs, papszArgs, pszProgramPath);
     600    int rc = rtR3InitBody(fFlags, cArgs, ppapszArgs, pszProgramPath);
    601601    if (RT_FAILURE(rc))
    602602    {
    … …  
    614614
    615615
    616 RTR3DECL(int) RTR3InitExe(int cArgs, char ***papszArgs, uint32_t fFlags)
     616RTR3DECL(int) RTR3InitExe(int cArgs, char ***ppapszArgs, uint32_t fFlags)
    617617{
    618618    Assert(!(fFlags & RTR3INIT_FLAGS_DLL));
    619     return rtR3Init(fFlags, cArgs, papszArgs, NULL);
     619    return rtR3Init(fFlags, cArgs, ppapszArgs, NULL);
    620620}
    621621
    … …  
    635635
    636636
    637 RTR3DECL(int) RTR3InitEx(uint32_t iVersion, uint32_t fFlags, int cArgs, char ***papszArgs, const char *pszProgramPath)
     637RTR3DECL(int) RTR3InitEx(uint32_t iVersion, uint32_t fFlags, int cArgs, char ***ppapszArgs, const char *pszProgramPath)
    638638{
    639639    AssertReturn(iVersion == RTR3INIT_VER_CUR, VERR_NOT_SUPPORTED);
    640     return rtR3Init(fFlags, cArgs, papszArgs, pszProgramPath);
     640    return rtR3Init(fFlags, cArgs, ppapszArgs, pszProgramPath);
    641641}
    642642

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

    r57358 r57926  
    525525
    526526
    527 RTR3DECL(int) RTIsoFsGetFileInfo(PRTISOFSFILE pFile, const char *pszPath,
    528                                  uint32_t *pcbOffset, size_t *pcbLength)
     527RTR3DECL(int) RTIsoFsGetFileInfo(PRTISOFSFILE pFile, const char *pszPath, uint32_t *poffInIso, size_t *pcbLength)
    529528{
    530529    AssertPtrReturn(pFile, VERR_INVALID_PARAMETER);
    531530    AssertPtrReturn(pszPath, VERR_INVALID_PARAMETER);
    532     AssertPtrReturn(pcbOffset, VERR_INVALID_PARAMETER);
     531    AssertPtrReturn(poffInIso, VERR_INVALID_PARAMETER);
    533532
    534533    PRTISOFSDIRRECORD pDirRecord;
    … …  
    545544        if (RT_SUCCESS(rc))
    546545        {
    547             *pcbOffset = pFileRecord->extent_location * RTISOFS_SECTOR_SIZE;
     546            *poffInIso = pFileRecord->extent_location * RTISOFS_SECTOR_SIZE;
    548547            *pcbLength = pFileRecord->extent_data_length;
    549548            rtIsoFsFreeDirectoryRecord(pFileRecord);
    … …  
    555554
    556555
    557 RTR3DECL(int) RTIsoFsExtractFile(PRTISOFSFILE pFile, const char *pszSource,
    558                                  const char *pszDest)
    559 {
    560     AssertPtrReturn(pFile, VERR_INVALID_PARAMETER);
    561     AssertPtrReturn(pszSource, VERR_INVALID_PARAMETER);
    562     AssertPtrReturn(pszDest, VERR_INVALID_PARAMETER);
     556RTR3DECL(int) RTIsoFsExtractFile(PRTISOFSFILE pFile, const char *pszSrcPath, const char *pszDstPath)
     557{
     558    AssertPtrReturn(pFile, VERR_INVALID_PARAMETER);
     559    AssertPtrReturn(pszSrcPath, VERR_INVALID_PARAMETER);
     560    AssertPtrReturn(pszDstPath, VERR_INVALID_PARAMETER);
    563561
    564562    uint32_t cbOffset;
    565563    size_t cbLength;
    566     int rc = RTIsoFsGetFileInfo(pFile, pszSource, &cbOffset, &cbLength);
     564    int rc = RTIsoFsGetFileInfo(pFile, pszSrcPath, &cbOffset, &cbLength);
    567565    if (RT_SUCCESS(rc))
    568566    {
    … …  
    571569        {
    572570            RTFILE fileDest;
    573             rc = RTFileOpen(&fileDest, pszDest, RTFILE_O_CREATE | RTFILE_O_WRITE | RTFILE_O_DENY_WRITE);
     571            rc = RTFileOpen(&fileDest, pszDstPath, RTFILE_O_CREATE | RTFILE_O_WRITE | RTFILE_O_DENY_WRITE);
    574572            if (RT_SUCCESS(rc))
    575573            {

  • trunk/src/VBox/Runtime/r3/nt/internal-r3-nt.h

    r56290 r57926  
    4949 * @returns @c true if equal, @c false if not.
    5050 * @param   pwsz1               The first string.
    51  * @param   cb1                 The length of the first string, in bytes.
     51 * @param   cch1                The length of the first string, in bytes.
    5252 * @param   psz2                The second string.
    5353 * @param   cch2                The length of the second string.

  • trunk/src/VBox/Runtime/win/errmsgwin.cpp

    r57358 r57926  
    4545static const RTWINERRMSG  g_aStatusMsgs[] =
    4646{
    47 #ifndef IPRT_NO_ERROR_DATA
     47#if !defined(IPRT_NO_ERROR_DATA) && !defined(DOXYGEN_RUNNING)
    4848# include "errmsgcomdata.h"
    4949# if defined(VBOX) && !defined(IN_GUEST)
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