VirtualBox

Changeset 58204 in vbox


Ignore:
Timestamp:
Oct 12, 2015 4:10:11 PM (9 years ago)
Author:
vboxsync
Message:

VBoxGuestLib: Fixed doxygen warnings.

Location:
trunk
Files:
10 edited

Legend:

Unmodified
Added
Removed

  • trunk/Makefile.kmk

    r58167 r58204  
    824824                -e '/warning. Unexpected tag .dd. found/d' \
    825825                -e '/warning. Unsupported xml.html tag .globalScope. found/d' \
    826                -e '/\/include\/VBox\/VBoxGuestLib\.h.* warning/b ignore' \
    827826               -e '/\/include\/VBox\/VBoxVideoGuest\.h.* warning/b ignore' \
    828827               -e '/\/include\/VBox\/sup\.h.* warning/b ignore' \
    … …  
    840839               -e '/\/src\/VBox\/Additions\/WINNT\/VBoxTray\/VBoxDnD\.h.* warning/b ignore' \
    841840               -e '/\/src\/VBox\/Additions\/WINNT\/VBoxTray\/VBoxDnD\.cpp.* warning/b ignore' \
    842                -e '/\/src\/VBox\/Additions\/common\/VBoxGuestLib\/.* warning/b ignore' \
    843841               -e '/\/src\/VBox\/Additions\/common\/VBoxVideo\/HGSMIBase\.cpp.* warning/b ignore' \
    844842               -e '/\/src\/VBox\/Additions\/common\/VBoxVideo\/Modesetting\.cpp.* warning/b ignore' \

  • trunk/include/VBox/VBoxGuestLib.h

    r58184 r58204  
    656656VBGLR3DECL(int) VbglR3GuestCtrlSessionGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puProtocol, char *pszUser, uint32_t cbUser,
    657657                                              char *pszPassword, uint32_t  cbPassword, char *pszDomain, uint32_t cbDomain,
    658                                               uint32_t *pfFlags, uint32_t *puSessionID);
    659 VBGLR3DECL(int) VbglR3GuestCtrlSessionGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *pfFlags, uint32_t *puSessionID);
     658                                              uint32_t *pfFlags, uint32_t *pidSession);
     659VBGLR3DECL(int) VbglR3GuestCtrlSessionGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *pfFlags, uint32_t *pidSession);
    660660/* Guest path handling. */
    661661VBGLR3DECL(int) VbglR3GuestCtrlPathGetRename(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszSource, uint32_t cbSource, char *pszDest,

  • trunk/include/VBox/VBoxGuestLibSharedFolders.h

    r58203 r58204  
    3232
    3333RT_C_DECLS_BEGIN
     34
     35
     36/** @addtogroup grp_vboxguest_lib_r0
     37 * @{
     38 */
    3439
    3540typedef struct VBGLSFCLIENT
    … …  
    97102
    98103DECLVBGL(int)  VbglR0SfDirInfo(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, SHFLHANDLE hFile,PSHFLSTRING ParsedPath, uint32_t flags,
    99                                  uint32_t index, uint32_t *pcbBuffer, PSHFLDIRINFO pBuffer, uint32_t *pcFiles);
     104                               uint32_t index, uint32_t *pcbBuffer, PSHFLDIRINFO pBuffer, uint32_t *pcFiles);
    100105DECLVBGL(int)  VbglR0SfFsInfo(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, SHFLHANDLE hFile, uint32_t flags, uint32_t *pcbBuffer, PSHFLDIRINFO pBuffer);
    101106
    … …  
    108113DECLVBGL(int)  VbglR0SfSetSymlinks(PVBGLSFCLIENT pClient);
    109114
     115/** @} */
     116
    110117RT_C_DECLS_END
    111118

  • trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibAdditions.cpp

    r58177 r58204  
    169169 * @copydoc VbglR3GetAdditionsVersion
    170170 */
    171 static int vbglR3GetAdditionsCompileTimeVersion(char **ppszVer, char **ppszVerEx, char **ppszRev)
     171static int vbglR3GetAdditionsCompileTimeVersion(char **ppszVer, char **ppszVerExt, char **ppszRev)
    172172{
    173173    int rc = VINF_SUCCESS;
    … …  
    176176    if (RT_SUCCESS(rc))
    177177    {
    178         if (ppszVerEx)
    179             rc = RTStrDupEx(ppszVerEx, VBOX_VERSION_STRING);
     178        if (ppszVerExt)
     179            rc = RTStrDupEx(ppszVerExt, VBOX_VERSION_STRING);
    180180        if (RT_SUCCESS(rc))
    181181        {
    … …  
    187187            /* bail out: */
    188188        }
    189         if (ppszVerEx)
    190         {
    191             RTStrFree(*ppszVerEx);
    192             *ppszVerEx = NULL;
     189        if (ppszVerExt)
     190        {
     191            RTStrFree(*ppszVerExt);
     192            *ppszVerExt = NULL;
    193193        }
    194194    }
    … …  
    330330 * @param   fReserved       Flags reserved for future hacks.
    331331 */
    332 VBGLR3DECL(int) VbglR3ReportAdditionsStatus(VBoxGuestFacilityType enmFacility,
    333                                             VBoxGuestFacilityStatus enmStatusCurrent,
     332VBGLR3DECL(int) VbglR3ReportAdditionsStatus(VBoxGuestFacilityType enmFacility, VBoxGuestFacilityStatus enmStatus,
    334333                                            uint32_t fReserved)
    335334{
    … …  
    340339    {
    341340        Report.guestStatus.facility = enmFacility;
    342         Report.guestStatus.status   = enmStatusCurrent;
     341        Report.guestStatus.status   = enmStatus;
    343342        Report.guestStatus.flags    = fReserved;
    344343

  • trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibClipboard.cpp

    r58183 r58204  
    6868 *
    6969 * @returns VBox status code.
    70  * @param   idClientId      The client id returned by VbglR3ClipboardConnect().
     70 * @param   idClient        The client id returned by VbglR3ClipboardConnect().
    7171 */
    7272VBGLR3DECL(int) VbglR3ClipboardDisconnect(HGCMCLIENTID idClient)

  • trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibCredentials.cpp

    r57358 r58204  
    112112 * @param   ppwszUser       Receives pointer of allocated user name string.
    113113 *                          The returned pointer must be freed using VbglR3CredentialsDestroyUtf16().
    114  * @param   ppswzPassword   Receives pointer of allocated user password string.
     114 * @param   ppwszPassword   Receives pointer of allocated user password string.
    115115 *                          The returned pointer must be freed using VbglR3CredentialsDestroyUtf16().
    116116 * @param   ppwszDomain     Receives pointer of allocated domain name string.

  • trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibGuestCtrl.cpp

    r58154 r58204  
    280280 * @return  IPRT status code.
    281281 * @param   pCtx                    Host context.
    282  * @param   uFlags
     282 * @param   fFlags                  Some kind of flag. Figure it out yourself.
    283283 ** @todo Docs!
    284284 */
    285 VBGLR3DECL(int) VbglR3GuestCtrlSessionClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uFlags)
     285VBGLR3DECL(int) VbglR3GuestCtrlSessionClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t fFlags)
    286286{
    287287    AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
    … …  
    296296
    297297    VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
    298     VbglHGCMParmUInt32Set(&Msg.flags, uFlags);
     298    VbglHGCMParmUInt32Set(&Msg.flags, fFlags);
    299299
    300300    int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CALL(sizeof(Msg)), &Msg, sizeof(Msg));
    … …  
    340340 *
    341341 * @return  IPRT status code.
    342  * @param   pCtx                    Host context.
    343342 ** @todo Docs!
    344343 */
    … …  
    348347                                              char     *pszPassword, uint32_t  cbPassword,
    349348                                              char     *pszDomain,   uint32_t  cbDomain,
    350                                               uint32_t *puFlags,     uint32_t *puSessionID)
     349                                              uint32_t *pfFlags,     uint32_t *pidSession)
    351350{
    352351    AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
    … …  
    357356    AssertPtrReturn(pszPassword, VERR_INVALID_POINTER);
    358357    AssertPtrReturn(pszDomain, VERR_INVALID_POINTER);
    359     AssertPtrReturn(puFlags, VERR_INVALID_POINTER);
     358    AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
    360359
    361360    HGCMMsgSessionOpen Msg;
    … …  
    385384            Msg.context.GetUInt32(&pCtx->uContextID);
    386385            Msg.protocol.GetUInt32(puProtocol);
    387             Msg.flags.GetUInt32(puFlags);
    388 
    389             if (puSessionID)
    390                 *puSessionID = VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(pCtx->uContextID);
     386            Msg.flags.GetUInt32(pfFlags);
     387
     388            if (pidSession)
     389                *pidSession = VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(pCtx->uContextID);
    391390        }
    392391    }
    … …  
    400399 *
    401400 * @return  IPRT status code.
    402  * @param   pCtx                    Host context.
    403401 ** @todo Docs!
    404402 */
    405 VBGLR3DECL(int) VbglR3GuestCtrlSessionGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puFlags, uint32_t *puSessionID)
     403VBGLR3DECL(int) VbglR3GuestCtrlSessionGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *pfFlags, uint32_t *pidSession)
    406404{
    407405    AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
    408406    AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
    409407
    410     AssertPtrReturn(puFlags, VERR_INVALID_POINTER);
     408    AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
    411409
    412410    HGCMMsgSessionClose Msg;
    … …  
    431429        {
    432430            Msg.context.GetUInt32(&pCtx->uContextID);
    433             Msg.flags.GetUInt32(puFlags);
    434 
    435             if (puSessionID)
    436                 *puSessionID = VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(pCtx->uContextID);
     431            Msg.flags.GetUInt32(pfFlags);
     432
     433            if (pidSession)
     434                *pidSession = VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(pCtx->uContextID);
    437435        }
    438436    }
    … …  
    445443                                             char     *pszSource,       uint32_t cbSource,
    446444                                             char     *pszDest,         uint32_t cbDest,
    447                                              uint32_t *puFlags)
     445                                             uint32_t *pfFlags)
    448446{
    449447    AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
    … …  
    454452    AssertPtrReturn(pszDest, VERR_INVALID_POINTER);
    455453    AssertReturn(cbDest, VERR_INVALID_PARAMETER);
    456     AssertPtrReturn(puFlags, VERR_INVALID_POINTER);
     454    AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
    457455
    458456    HGCMMsgPathRename Msg;
    … …  
    479477        {
    480478            Msg.context.GetUInt32(&pCtx->uContextID);
    481             Msg.flags.GetUInt32(puFlags);
     479            Msg.flags.GetUInt32(pfFlags);
    482480        }
    483481    }
    … …  
    497495VBGLR3DECL(int) VbglR3GuestCtrlProcGetStart(PVBGLR3GUESTCTRLCMDCTX    pCtx,
    498496                                            char     *pszCmd,         uint32_t  cbCmd,
    499                                             uint32_t *puFlags,
     497                                            uint32_t *pfFlags,
    500498                                            char     *pszArgs,        uint32_t  cbArgs,     uint32_t *pcArgs,
    501499                                            char     *pszEnv,         uint32_t *pcbEnv,     uint32_t *pcEnvVars,
    … …  
    509507
    510508    AssertPtrReturn(pszCmd, VERR_INVALID_POINTER);
    511     AssertPtrReturn(puFlags, VERR_INVALID_POINTER);
     509    AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
    512510    AssertPtrReturn(pszArgs, VERR_INVALID_POINTER);
    513511    AssertPtrReturn(pcArgs, VERR_INVALID_POINTER);
    … …  
    565563        {
    566564            Msg.context.GetUInt32(&pCtx->uContextID);
    567             Msg.flags.GetUInt32(puFlags);
     565            Msg.flags.GetUInt32(pfFlags);
    568566            Msg.num_args.GetUInt32(pcArgs);
    569567            Msg.num_env.GetUInt32(pcEnvVars);
    … …  
    594592 */
    595593VBGLR3DECL(int) VbglR3GuestCtrlProcGetOutput(PVBGLR3GUESTCTRLCMDCTX pCtx,
    596                                              uint32_t *puPID, uint32_t *puHandle, uint32_t *puFlags)
     594                                             uint32_t *puPID, uint32_t *puHandle, uint32_t *pfFlags)
    597595{
    598596    AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
    … …  
    601599    AssertPtrReturn(puPID, VERR_INVALID_POINTER);
    602600    AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
    603     AssertPtrReturn(puFlags, VERR_INVALID_POINTER);
     601    AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
    604602
    605603    HGCMMsgProcOutput Msg;
    … …  
    628626            Msg.pid.GetUInt32(puPID);
    629627            Msg.handle.GetUInt32(puHandle);
    630             Msg.flags.GetUInt32(puFlags);
     628            Msg.flags.GetUInt32(pfFlags);
    631629        }
    632630    }
    … …  
    645643 */
    646644VBGLR3DECL(int) VbglR3GuestCtrlProcGetInput(PVBGLR3GUESTCTRLCMDCTX  pCtx,
    647                                             uint32_t  *puPID,       uint32_t *puFlags,
     645                                            uint32_t  *puPID,       uint32_t *pfFlags,
    648646                                            void      *pvData,      uint32_t  cbData,
    649647                                            uint32_t  *pcbSize)
    … …  
    653651
    654652    AssertPtrReturn(puPID, VERR_INVALID_POINTER);
    655     AssertPtrReturn(puFlags, VERR_INVALID_POINTER);
     653    AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
    656654    AssertPtrReturn(pvData, VERR_INVALID_POINTER);
    657655    AssertPtrReturn(pcbSize, VERR_INVALID_POINTER);
    … …  
    682680            Msg.context.GetUInt32(&pCtx->uContextID);
    683681            Msg.pid.GetUInt32(puPID);
    684             Msg.flags.GetUInt32(puFlags);
     682            Msg.flags.GetUInt32(pfFlags);
    685683            Msg.size.GetUInt32(pcbSize);
    686684        }
    … …  
    692690VBGLR3DECL(int) VbglR3GuestCtrlDirGetRemove(PVBGLR3GUESTCTRLCMDCTX     pCtx,
    693691                                            char     *pszPath,         uint32_t cbPath,
    694                                             uint32_t *puFlags)
     692                                            uint32_t *pfFlags)
    695693{
    696694    AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
    … …  
    699697    AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
    700698    AssertReturn(cbPath, VERR_INVALID_PARAMETER);
    701     AssertPtrReturn(puFlags, VERR_INVALID_POINTER);
     699    AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
    702700
    703701    HGCMMsgDirRemove Msg;
    … …  
    723721        {
    724722            Msg.context.GetUInt32(&pCtx->uContextID);
    725             Msg.flags.GetUInt32(puFlags);
     723            Msg.flags.GetUInt32(pfFlags);
    726724        }
    727725    }
    … …  
    13441342 */
    13451343VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatus(PVBGLR3GUESTCTRLCMDCTX pCtx,
    1346                                             uint32_t uPID, uint32_t uStatus, uint32_t uFlags,
     1344                                            uint32_t uPID, uint32_t uStatus, uint32_t fFlags,
    13471345                                            void  *pvData, uint32_t cbData)
    13481346{
    … …  
    13591357    VbglHGCMParmUInt32Set(&Msg.pid, uPID);
    13601358    VbglHGCMParmUInt32Set(&Msg.status, uStatus);
    1361     VbglHGCMParmUInt32Set(&Msg.flags, uFlags);
     1359    VbglHGCMParmUInt32Set(&Msg.flags, fFlags);
    13621360    VbglHGCMParmPtrSet(&Msg.data, pvData, cbData);
    13631361
    … …  
    13801378 */
    13811379VBGLR3DECL(int) VbglR3GuestCtrlProcCbOutput(PVBGLR3GUESTCTRLCMDCTX pCtx,
    1382                                             uint32_t uPID,uint32_t uHandle, uint32_t uFlags,
     1380                                            uint32_t uPID,uint32_t uHandle, uint32_t fFlags,
    13831381                                            void *pvData, uint32_t cbData)
    13841382{
    … …  
    13951393    VbglHGCMParmUInt32Set(&Msg.pid, uPID);
    13961394    VbglHGCMParmUInt32Set(&Msg.handle, uHandle);
    1397     VbglHGCMParmUInt32Set(&Msg.flags, uFlags);
     1395    VbglHGCMParmUInt32Set(&Msg.flags, fFlags);
    13981396    VbglHGCMParmPtrSet(&Msg.data, pvData, cbData);
    13991397
    … …  
    14171415VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatusInput(PVBGLR3GUESTCTRLCMDCTX pCtx,
    14181416                                                 uint32_t uPID, uint32_t uStatus,
    1419                                                  uint32_t uFlags, uint32_t cbWritten)
     1417                                                 uint32_t fFlags, uint32_t cbWritten)
    14201418{
    14211419    AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
    … …  
    14311429    VbglHGCMParmUInt32Set(&Msg.pid, uPID);
    14321430    VbglHGCMParmUInt32Set(&Msg.status, uStatus);
    1433     VbglHGCMParmUInt32Set(&Msg.flags, uFlags);
     1431    VbglHGCMParmUInt32Set(&Msg.flags, fFlags);
    14341432    VbglHGCMParmUInt32Set(&Msg.written, cbWritten);
    14351433

  • trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibGuestProp.cpp

    r58183 r58204  
    328328 *                          Optional.
    329329 * @param   pu64Timestamp   Where to store the timestamp.  Optional.
    330  * @param   pszFlags        Where to store the pointer to the flags.  Optional.
     330 * @param   ppszFlags       Where to store the pointer to the flags.  Optional.
    331331 * @param   pcbBufActual    If @a pcBuf is not large enough, the size needed.
    332332 *                          Optional.
    … …  
    521521 * @returns VBox status code.
    522522 * @retval  VINF_SUCCESS on success and pcBuf points to a packed array
    523  *          of the form <name>, <value>, <timestamp string>, <flags>,
     523 *          of the form \<name\>, \<value\>, \<timestamp string\>, \<flags\>,
    524524 *          terminated by four empty strings.  pcbBufActual will contain the
    525525 *          total size of the array.
    … …  
    529529 *
    530530 * @param   idClient      The client ID returned by VbglR3GuestPropConnect
    531  * @param   paszPatterns  A packed array of zero terminated strings, terminated
     531 * @param   pszzPatterns  A packed array of zero terminated strings, terminated
    532532 *                        by an empty string.
    533533 * @param   pcBuf         The buffer to store the results to.

  • trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibMisc.cpp

    r57358 r58204  
    3838 * @returns IPRT status code.
    3939 * @param   fOr     The OR mask.
    40  * @param   fNo     The NOT mask.
     40 * @param   fNot    The NOT mask.
    4141 */
    4242VBGLR3DECL(int) VbglR3CtlFilterMask(uint32_t fOr, uint32_t fNot)

  • trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibVideo.cpp

    r58191 r58204  
    154154 * @param   pcBits      Where to store the bits per pixel requested (a value
    155155 *                      of zero means do not change).
    156  * @param   iDisplay    Where to store the display number the request was for
     156 * @param   piDisplay   Where to store the display number the request was for
    157157 *                      - 0 for the primary display, 1 for the first
    158158 *                      secondary display, etc.
    … …  
    213213 * @param   pdy         New vertical position of the secondary monitor.
    214214 *                      Optional.
    215  * param    pfEnabled   Secondary monitor is enabled or not.
    216  *                      Optional.
    217  * param    pfChangeOrigin  Whether the mode hint retrieved included information
    218  *                      about origin/display offset inside the frame-buffer.
    219  *                      Optional.
     215 * @param   pfEnabled   Secondary monitor is enabled or not. Optional.
     216 * @param   pfChangeOrigin  Whether the mode hint retrieved included
     217 *                      information about origin/display offset inside the
     218 *                      frame-buffer. Optional.
    220219 *
    221220 */
Note: See TracChangeset for help on using the changeset viewer.

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