VirtualBox

Changeset 65088 in vbox for trunk/src


Ignore:
Timestamp:
Jan 3, 2017 8:52:49 PM (8 years ago)
Author:
vboxsync
Message:

Main: doxygen fixes

Location:
trunk/src/VBox/Main
Files:
40 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/Main/glue/NativeEventQueue.cpp

    r63147 r65088  
    600600 *  Posts an event to this event loop asynchronously.
    601601 *
    602  *  @param  event   the event to post, must be allocated using |new|
    603  *  @return         TRUE if successful and false otherwise
     602 *  @param  pEvent  the event to post, must be allocated using |new|
     603 *  @return         @c TRUE if successful and false otherwise
    604604 */
    605605BOOL NativeEventQueue::postEvent(NativeEvent *pEvent)

  • trunk/src/VBox/Main/include/ApplianceImpl.h

    r63184 r65088  
    178178    void i_convertDiskAttachmentValues(const ovf::HardDiskController &hdc,
    179179                                       uint32_t ulAddressOnParent,
    180                                        Utf8Str &controllerType,
     180                                       Utf8Str &controllerName,
    181181                                       int32_t &lControllerPort,
    182182                                       int32_t &lDevice);

  • trunk/src/VBox/Main/include/BandwidthGroupImpl.h

    r61194 r65088  
    3737    // public initializer/uninitializer for internal purposes only
    3838    HRESULT init(BandwidthControl *aParent,
    39                  const Utf8Str &aName,
     39                 const com::Utf8Str &aName,
    4040                 BandwidthGroupType_T aType,
    4141                 LONG64 aMaxBytesPerSec);

  • trunk/src/VBox/Main/include/ConsoleImpl.h

    r64134 r65088  
    401401     *
    402402     *  @sa SafeVMPtr, SafeVMPtrQuiet
    403      *  @obsolete Use SafeVMPtr
     403     *  @note Obsolete, use SafeVMPtr
    404404     */
    405405    typedef AutoVMCallerBase<false, false> AutoVMCaller;
    … …  
    410410     *
    411411     *  @note Temporarily locks the argument for writing.
    412     *  @obsolete Use SafeVMPtrQuiet
     412     *  @note Obsolete, use SafeVMPtrQuiet
    413413     */
    414414    typedef AutoVMCallerBase<true, false> AutoVMCallerQuiet;
    … …  
    419419     *
    420420     *  @note Temporarily locks the argument for writing.
    421      *  @obsolete Use SafeVMPtr
     421     *  @note Obsolete, use SafeVMPtr
    422422     */
    423423    typedef AutoVMCallerBase<false, true> AutoVMCallerWeak;
    … …  
    429429     *
    430430     *  @note Temporarily locks the argument for writing.
    431      *  @obsolete Use SafeVMPtrQuiet
     431     *  @note Obsolete, use SafeVMPtrQuiet
    432432     */
    433433    typedef AutoVMCallerBase<true, true> AutoVMCallerQuietWeak;

  • trunk/src/VBox/Main/include/HostPower.h

    r62485 r65088  
    4545};
    4646
    47 # ifdef RT_OS_WINDOWS
     47# if defined(RT_OS_WINDOWS) || defined(DOXYGEN_RUNNING)
    4848/**
    4949 * The Windows hosted Power Service.
    … …  
    6464    RTTHREAD    mThread;
    6565};
    66 #elif defined(RT_OS_LINUX)
     66# endif
     67# if defined(RT_OS_LINUX) || defined(DOXYGEN_RUNNING)
    6768/**
    6869 * The Linux hosted Power Service.
    … …  
    8788};
    8889
    89 # elif defined(RT_OS_DARWIN) /* RT_OS_WINDOWS */
     90# endif
     91# if defined(RT_OS_DARWIN) || defined(DOXYGEN_RUNNING)
    9092/**
    9193 * The Darwin hosted Power Service.
    … …  
    116118    bool mCritical; /* Indicate if the battery was in the critical state last checked */
    117119};
    118 # endif /* RT_OS_DARWIN */
     120# endif
    119121
    120122#endif /* !____H_HOSTPOWER */

  • trunk/src/VBox/Main/include/PCIDeviceAttachmentImpl.h

    r61009 r65088  
    3737    // public initializer/uninitializer for internal purposes only
    3838    HRESULT init(IMachine *    aParent,
    39                  const Utf8Str &aName,
     39                 const Utf8Str &aDevName,
    4040                 LONG          aHostAddess,
    4141                 LONG          aGuestAddress,

  • trunk/src/VBox/Main/include/SharedFolderImpl.h

    r62485 r65088  
    3636
    3737    // public initializer/uninitializer for internal purposes only
    38     HRESULT init(Machine *aMachine, const Utf8Str &aName, const Utf8Str &aHostPath, bool aWritable, bool aAutoMount, bool fFailOnError);
     38    HRESULT init(Machine *aMachine, const com::Utf8Str &aName, const com::Utf8Str &aHostPath, bool aWritable, bool aAutoMount, bool fFailOnError);
    3939    HRESULT initCopy(Machine *aMachine, SharedFolder *aThat);
    40     HRESULT init(Console *aConsole, const Utf8Str &aName, const Utf8Str &aHostPath, bool aWritable, bool aAutoMount, bool fFailOnError);
     40    HRESULT init(Console *aConsole, const com::Utf8Str &aName, const com::Utf8Str &aHostPath, bool aWritable, bool aAutoMount, bool fFailOnError);
    4141//     HRESULT init(VirtualBox *aVirtualBox, const Utf8Str &aName, const Utf8Str &aHostPath, bool aWritable, bool aAutoMount, bool fFailOnError);
    4242    void uninit();

  • trunk/src/VBox/Main/include/SnapshotImpl.h

    r62485 r65088  
    4040    HRESULT init(VirtualBox *aVirtualBox,
    4141                 const Guid &aId,
    42                  const Utf8Str &aName,
    43                  const Utf8Str &aDescription,
     42                 const com::Utf8Str &aName,
     43                 const com::Utf8Str &aDescription,
    4444                 const RTTIMESPEC &aTimeStamp,
    4545                 SnapshotMachine *aMachine,
    … …  
    8080
    8181    ComObjPtr<Snapshot> i_findChildOrSelf(IN_GUID aId);
    82     ComObjPtr<Snapshot> i_findChildOrSelf(const Utf8Str &aName);
     82    ComObjPtr<Snapshot> i_findChildOrSelf(const com::Utf8Str &aName);
    8383
    8484    void i_updateSavedStatePaths(const Utf8Str &strOldPath,

  • trunk/src/VBox/Main/include/StorageControllerImpl.h

    r62485 r65088  
    3434    // public initializer/uninitializer for internal purposes only
    3535    HRESULT init(Machine *aParent,
    36                  const Utf8Str &aName,
     36                 const com::Utf8Str &aName,
    3737                 StorageBus_T aBus,
    3838                 ULONG aInstance,

  • trunk/src/VBox/Main/include/USBControllerImpl.h

    r62485 r65088  
    4242
    4343    // public initializer/uninitializer for internal purposes only
    44     HRESULT init(Machine *aParent, const Utf8Str &aName, USBControllerType_T enmType);
     44    HRESULT init(Machine *aParent, const com::Utf8Str &aName, USBControllerType_T enmType);
    4545    HRESULT init(Machine *aParent, USBController *aThat, bool fReshare = false);
    4646    HRESULT initCopy(Machine *aParent, USBController *aThat);

  • trunk/src/VBox/Main/include/USBGetDevices.h

    r62485 r65088  
    6363/**
    6464 * Free a linked list of USB devices created by the Linux enumeration code.
    65  * @param  pHead  Pointer to the first device in the linked list
     65 * @param  ppHead  Pointer to the first device in the linked list
    6666 */
    6767DECLINLINE(void) deviceListFree(PUSBDEVICE *ppHead)

  • trunk/src/VBox/Main/include/USBProxyBackend.h

    r65063 r65088  
    4242public:
    4343
    44     DECLARE_EMPTY_CTOR_DTOR (USBProxyBackend)
     44    DECLARE_EMPTY_CTOR_DTOR(USBProxyBackend)
    4545
    4646    HRESULT FinalConstruct();
    … …  
    131131
    132132
    133 # ifdef RT_OS_DARWIN
     133# if defined(RT_OS_DARWIN) || defined(DOXYGEN_RUNNING)
    134134#  include <VBox/param.h>
    135135#  undef PAGE_SHIFT
    … …  
    145145{
    146146public:
    147     DECLARE_EMPTY_CTOR_DTOR (USBProxyBackendDarwin)
     147    DECLARE_EMPTY_CTOR_DTOR(USBProxyBackendDarwin)
    148148
    149149    int init(USBProxyService *pUsbProxyService, const com::Utf8Str &strId, const com::Utf8Str &strAddress);
    … …  
    182182
    183183
    184 # ifdef RT_OS_LINUX
     184# if defined(RT_OS_LINUX) || defined(DOXYGEN_RUNNING)
    185185#  include <stdio.h>
    186186#  ifdef VBOX_USB_WITH_SYSFS
    … …  
    194194{
    195195public:
    196     DECLARE_EMPTY_CTOR_DTOR (USBProxyBackendLinux)
     196    DECLARE_EMPTY_CTOR_DTOR(USBProxyBackendLinux)
    197197
    198198    int init(USBProxyService *pUsbProxyService, const com::Utf8Str &strId, const com::Utf8Str &strAddress);
    … …  
    237237
    238238
    239 # ifdef RT_OS_OS2
     239# if defined(RT_OS_OS2) || defined(DOXYGEN_RUNNING)
    240240#  include <usbcalls.h>
    241241
    … …  
    246246{
    247247public:
    248     DECLARE_EMPTY_CTOR_DTOR (USBProxyBackend)
    249 
    250     virtual int captureDevice (HostUSBDevice *aDevice);
    251     virtual int releaseDevice (HostUSBDevice *aDevice);
     248    DECLARE_EMPTY_CTOR_DTOR(USBProxyBackendOs2)
     249
     250    virtual int captureDevice(HostUSBDevice *aDevice);
     251    virtual int releaseDevice(HostUSBDevice *aDevice);
    252252
    253253protected:
    … …  
    273273    APIRET (APIENTRY *mpfnUsbQueryDeviceReport)(ULONG, PULONG, PVOID);
    274274};
    275 # endif /* RT_OS_LINUX */
    276 
    277 
    278 # ifdef RT_OS_SOLARIS
     275# endif /* RT_OS_OS2 */
     276
     277
     278# if defined(RT_OS_SOLARIS) || defined(DOXYGEN_RUNNING)
    279279#  include <libdevinfo.h>
    280280
    … …  
    285285{
    286286public:
    287     DECLARE_EMPTY_CTOR_DTOR (USBProxyBackendSolaris)
     287    DECLARE_EMPTY_CTOR_DTOR(USBProxyBackendSolaris)
    288288
    289289    int init(USBProxyService *pUsbProxyService, const com::Utf8Str &strId, const com::Utf8Str &strAddress);
    … …  
    293293    virtual void removeFilter (void *aID);
    294294
    295     virtual int captureDevice (HostUSBDevice *aDevice);
    296     virtual int releaseDevice (HostUSBDevice *aDevice);
     295    virtual int captureDevice(HostUSBDevice *aDevice);
     296    virtual int releaseDevice(HostUSBDevice *aDevice);
    297297    virtual void captureDeviceCompleted(HostUSBDevice *aDevice, bool aSuccess);
    298298    virtual void releaseDeviceCompleted(HostUSBDevice *aDevice, bool aSuccess);
    … …  
    313313
    314314
    315 # ifdef RT_OS_WINDOWS
     315# if defined(RT_OS_WINDOWS) || defined(DOXYGEN_RUNNING)
    316316/**
    317317 * The Windows hosted USB Proxy Backend.
    … …  
    320320{
    321321public:
    322     DECLARE_EMPTY_CTOR_DTOR (USBProxyBackendWindows)
     322    DECLARE_EMPTY_CTOR_DTOR(USBProxyBackendWindows)
    323323
    324324    int init(USBProxyService *pUsbProxyService, const com::Utf8Str &strId, const com::Utf8Str &strAddress);
    … …  
    328328    virtual void removeFilter (void *aID);
    329329
    330     virtual int captureDevice (HostUSBDevice *aDevice);
    331     virtual int releaseDevice (HostUSBDevice *aDevice);
     330    virtual int captureDevice(HostUSBDevice *aDevice);
     331    virtual int releaseDevice(HostUSBDevice *aDevice);
    332332
    333333    virtual bool i_isDevReEnumerationRequired();
    … …  
    344344# endif /* RT_OS_WINDOWS */
    345345
    346 # ifdef RT_OS_FREEBSD
     346# if defined(RT_OS_FREEBSD) || defined(DOXYGEN_RUNNING)
    347347/**
    348348 * The FreeBSD hosted USB Proxy Backend.
    … …  
    351351{
    352352public:
    353     DECLARE_EMPTY_CTOR_DTOR (USBProxyBackendFreeBSD)
     353    DECLARE_EMPTY_CTOR_DTOR(USBProxyBackendFreeBSD)
    354354
    355355    int init(USBProxyService *pUsbProxyService, const com::Utf8Str &strId, const com::Utf8Str &strAddress);
    … …  
    402402{
    403403public:
    404     DECLARE_EMPTY_CTOR_DTOR (USBProxyBackendUsbIp)
     404    DECLARE_EMPTY_CTOR_DTOR(USBProxyBackendUsbIp)
    405405
    406406    int init(USBProxyService *pUsbProxyService, const com::Utf8Str &strId, const com::Utf8Str &strAddress);

  • trunk/src/VBox/Main/include/VirtualBoxBase.h

    r63643 r65088  
    593593     * translation"). See VirtualBoxBase::translate() for more info.
    594594     *
    595      * @param aSourceText  String to translate.
     595     * @param pcszSourceText String to translate.
    596596     * @param aComment      Comment to the string to resolve possible
    597597     *                      ambiguities (NULL means no comment).
    … …  
    641641 * of a class derived from VirtualBoxBase cannot be instantiated.
    642642 *
    643  * @param X The class name, e.g. "Class".
    644  * @param IX The interface name which this class implements, e.g. "IClass".
     643 * @param cls The class name, e.g. "Class".
     644 * @param iface The interface name which this class implements, e.g. "IClass".
    645645 */
    646646#ifdef VBOX_WITH_XPCOM

  • trunk/src/VBox/Main/include/VirtualBoxImpl.h

    r63187 r65088  
    179179                                ComObjPtr<Machine> *aMachine = NULL);
    180180
    181     HRESULT i_validateMachineGroup(const Utf8Str &aGroup, bool fPrimary);
     181    HRESULT i_validateMachineGroup(const com::Utf8Str &aGroup, bool fPrimary);
    182182    HRESULT i_convertMachineGroups(const std::vector<com::Utf8Str> aMachineGroups, StringsList *pllMachineGroups);
    183183

  • trunk/src/VBox/Main/src-all/ExtPackUtil.cpp

    r62485 r65088  
    272272 * @returns NULL on success, pointer to an error message on failure (caller
    273273 *          deletes it).
    274  * @param   a_pszDir        The directory containing the description file.
     274 * @param   hVfsFile        The file handle of the description file.
    275275 * @param   a_pExtPackDesc  Where to store the extension pack descriptor.
    276276 * @param   a_pObjInfo      Where to store the object info for the file (unix
    … …  
    678678 *
    679679 * @returns VBox status code, failures with message.
    680  * @param   hManifestFile       The xml from the extension pack.
     680 * @param   hXmlFile            The xml from the extension pack.
    681681 * @param   pszExtPackName      The expected extension pack name.  This can be
    682682 *                              NULL, in which we don't have any expectations.

  • trunk/src/VBox/Main/src-all/VirtualBoxBase.cpp

    r63147 r65088  
    267267 *  recognize that the created error info object represents a warning rather
    268268 *  than an error.
     269 *
     270 *  @param  aResultCode
     271 *  @param  aIID
     272 *  @param  pcszComponent
     273 *  @param  aText
     274 *  @param  aWarning
     275 *  @param  aLogIt
     276 *  @param  aResultDetail
    269277 */
    270278/* static */
    … …  
    447455 * virtual getClassIID() and getComponentName() methods which are automatically
    448456 * defined by the VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT macro.
    449  * @param aResultCode
    450  * @param pcsz
     457 * @param   aResultCode
    451458 * @return
    452459 */
    … …  
    466473 * virtual getClassIID() and getComponentName() methods which are automatically
    467474 * defined by the VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT macro.
    468  * @param aResultCode
     475 * @param   aResultCode
     476 * @param   pcsz
    469477 * @return
    470478 */
    … …  
    488496 * virtual getClassIID() and getComponentName() methods which are automatically
    489497 * defined by the VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT macro.
    490  * @param ei
     498 * @param   ei
    491499 * @return
    492500 */

  • trunk/src/VBox/Main/src-all/win/VBoxProxyStub.c

    r63260 r65088  
    280280/**
    281281 * Pure virtual method implementation referenced by VirtualBox_p.c
    282  *
    283  * @returns New reference count.
    284  * @param   pThis               Buffer to release.
    285282 */
    286283void __cdecl _purecall(void)                                                              /* see DLLDUMMYPURECALL in RpcProxy.h */
    … …  
    370367 * @param   pszSubRoot      The path to the where the classes are registered,
    371368 *                          NULL if @a hkeyRoot.
    372  * @param   hkeyAltRoot     The registry root tree constant for the alternative
    373  *                          registrations (remove only).
    374  * @param   pszAltSubRoot   The path to where classes could also be registered,
    375  *                          but shouldn't be in our setup.
    376369 * @param   fDelete         Whether to delete registrations first.
    377370 * @param   fUpdate         Whether to update registrations.
    … …  
    12671260 *
    12681261 * @returns COM status code.
     1262 * @param   pState
    12691263 * @param   pwszVBoxDir         The VirtualBox application directory.
    12701264 * @param   fIs32On64           Set if this is the 32-bit on 64-bit component.
    … …  
    14231417 *
    14241418 * @param   pState              The registry modifier state.
    1425  * @param   pwszVBoxDir         The VirtualBox install directory (unicode),
    1426  *                              trailing slash.
    1427  * @param   fIs32On64           Set if we're registering the 32-bit proxy stub
    1428  *                              on a 64-bit system.
    14291419 */
    14301420static void vbpsUpdateInterfaceRegistrations(VBPSREGSTATE *pState)

  • trunk/src/VBox/Main/src-client/ConsoleImpl2.cpp

    r64786 r65088  
    286286 * Helper that calls CFGMR3InsertString and throws an RTCError if that
    287287 * fails (C-string variant).
    288  * @param   pParent         See CFGMR3InsertStringN.
    289  * @param   pcszNodeName    See CFGMR3InsertStringN.
     288 * @param   pNode           See CFGMR3InsertStringN.
     289 * @param   pcszName        See CFGMR3InsertStringN.
    290290 * @param   pcszValue       The string value.
    291291 */
    … …  
    304304 * Helper that calls CFGMR3InsertString and throws an RTCError if that
    305305 * fails (Utf8Str variant).
    306  * @param   pParent         See CFGMR3InsertStringN.
    307  * @param   pcszNodeName    See CFGMR3InsertStringN.
     306 * @param   pNode           See CFGMR3InsertStringN.
     307 * @param   pcszName        See CFGMR3InsertStringN.
    308308 * @param   rStrValue       The string value.
    309309 */
    … …  
    324324 * fails (Bstr variant).
    325325 *
    326  * @param   pParent         See CFGMR3InsertStringN.
    327  * @param   pcszNodeName    See CFGMR3InsertStringN.
    328  * @param   rBstrValue       The string value.
     326 * @param   pNode           See CFGMR3InsertStringN.
     327 * @param   pcszName        See CFGMR3InsertStringN.
     328 * @param   rBstrValue      The string value.
    329329 */
    330330static void InsertConfigString(PCFGMNODE pNode,

  • trunk/src/VBox/Main/src-client/ConsoleImplTeleporter.cpp

    r63239 r65088  
    530530 * @copydoc SSMSTRMOPS::pfnClose
    531531 */
    532 static DECLCALLBACK(int) teleporterTcpOpClose(void *pvUser, bool fCanceled)
     532static DECLCALLBACK(int) teleporterTcpOpClose(void *pvUser, bool fCancelled)
    533533{
    534534    TeleporterState *pState = (TeleporterState *)pvUser;
    … …  
    538538        TELEPORTERTCPHDR EofHdr;
    539539        EofHdr.u32Magic = TELEPORTERTCPHDR_MAGIC;
    540         EofHdr.cb       = fCanceled ? UINT32_MAX : 0;
     540        EofHdr.cb       = fCancelled ? UINT32_MAX : 0;
    541541        int rc = RTTcpWrite(pState->mhSocket, &EofHdr, sizeof(EofHdr));
    542542        if (RT_FAILURE(rc))

  • trunk/src/VBox/Main/src-client/GuestProcessImpl.cpp

    r64532 r65088  
    562562
    563563/**
    564  * Returns @true if the passed in error code indicates an error which came from the guest side,
    565  * or @false if not.
     564 * Returns @c true if the passed in error code indicates an error which came
     565 * from the guest side, or @c false if not.
    566566 *
    567  * @return  bool                @true if the passed in error code indicates an error which came from the guest side,
    568  *                              or @false if not.
     567 * @return  bool                @c true if the passed in error code indicates an error which came
     568 *                              from the guest side, or @c false if not.
    569569 * @param   rc                  Error code to check.
    570570 */

  • trunk/src/VBox/Main/src-client/MachineDebuggerImpl.cpp

    r63244 r65088  
    889889 * @interface_method_impl{DBGFINFOHLP,pfnPrintfV}
    890890 */
    891 static DECLCALLBACK(void) MachineDebuggerInfoPrintfV(PCDBGFINFOHLP pHlp, const char *pszFormat, va_list va)
    892 {
    893     RTStrFormatV(MachineDebuggerInfoOutput, (void *)pHlp, NULL,  NULL, pszFormat, va);
     891static DECLCALLBACK(void) MachineDebuggerInfoPrintfV(PCDBGFINFOHLP pHlp, const char *pszFormat, va_list args)
     892{
     893    RTStrFormatV(MachineDebuggerInfoOutput, (void *)pHlp, NULL,  NULL, pszFormat, args);
    894894}
    895895

  • trunk/src/VBox/Main/src-client/VMMDevInterface.cpp

    r63259 r65088  
    174174                                              const char *pszUser, const char *pszDomain,
    175175                                              uint32_t uState,
    176                                               const uint8_t *puDetails, uint32_t cbDetails)
     176                                              const uint8_t *pabDetails, uint32_t cbDetails)
    177177{
    178178    PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
    … …  
    186186
    187187    pGuest->i_onUserStateChange(Bstr(pszUser), Bstr(pszDomain), (VBoxGuestUserState)uState,
    188                                 puDetails, cbDetails);
     188                                pabDetails, cbDetails);
    189189}
    190190
    … …  
    312312 *
    313313 * @param   pInterface          Pointer to this interface.
    314  * @param   newCapabilities     New capabilities.
     314 * @param   fNewCaps            New capabilities.
    315315 * @thread  The emulation thread.
    316316 */

  • trunk/src/VBox/Main/src-client/VideoRec.cpp

    r63256 r65088  
    466466 * @returns IPRT status code.
    467467 * @param   pCtx                Pointer to video recording context to initialize Framebuffer width.
    468  * @param   uScreeen            Screen number.
    469  * @param   strFile             File to save the recorded data
    470  * @param   uTargetWidth        Width of the target image in the video recoriding file (movie)
    471  * @param   uTargetHeight       Height of the target image in video recording file.
     468 * @param   uScreen             Screen number.
     469 * @param   pszFile             File to save the recorded data
     470 * @param   uWidth              Width of the target image in the video recoriding file (movie)
     471 * @param   uHeight             Height of the target image in video recording file.
     472 * @param   uRate               Rate.
     473 * @param   uFps                FPS.
     474 * @param   uMaxTime
     475 * @param   uMaxFileSize
     476 * @param   pszOptions
    472477 */
    473478int VideoRecStrmInit(PVIDEORECCONTEXT pCtx, uint32_t uScreen, const char *pszFile,
    … …  
    710715 *
    711716 * @returns IPRT status code.
    712  * @param   pCtx  Pointer to video recording context.
    713  * @param   uSourceWidth      Width of the source image.
    714  * @param   uSourceHeight     Height of the source image.
     717 * @param   pStrm             Stream.
    715718 */
    716719static int videoRecEncodeAndWrite(PVIDEORECSTREAM pStrm)
    … …  
    756759 *
    757760 * @returns IPRT status code.
    758  * @param   pCtx      Pointer to video recording context.
     761 * @param   pStrm      Strm.
    759762 */
    760763static int videoRecRGBToYUV(PVIDEORECSTREAM pStrm)

  • trunk/src/VBox/Main/src-server/ApplianceImpl.cpp

    r63563 r65088  
    270270 * Private helper func that suggests a VirtualBox guest OS type
    271271 * for the given OVF operating system type.
    272  * @param osTypeVBox
     272 * @param strType
    273273 * @param c
    274274 * @param cStr
    … …  
    446446/**
    447447 * Public method implementation.
    448  * @param
     448 * @param   aPath
    449449 * @return
    450450 */
    … …  
    463463/**
    464464 * Public method implementation.
    465  * @param
     465 * @param aDisks
    466466 * @return
    467467 */
    … …  
    531531/**
    532532 * Public method implementation.
    533  * @param
     533 * @param   aVirtualSystemDescriptions
    534534 * @return
    535535 */
    … …  
    553553/**
    554554 * Public method implementation.
    555  * @param aDisks
     555 * @param aMachines
    556556 * @return
    557557 */
    … …  
    15641564 * @param aType Type of description for the new item.
    15651565 * @param strRef Reference item; only used with hard disk controllers.
    1566  * @param aOrigValue Corresponding original value from OVF.
    1567  * @param aAutoValue Initial configuration value (can be overridden by caller with setFinalValues).
     1566 * @param aOvfValue Corresponding original value from OVF.
     1567 * @param aVBoxValue Initial configuration value (can be overridden by caller with setFinalValues).
    15681568 * @param ulSizeMB Weight for IProgress
    15691569 * @param strExtraConfig Extra configuration; meaning dependent on type.

  • trunk/src/VBox/Main/src-server/ApplianceImplImport.cpp

    r63563 r65088  
    892892 * Opens a source file (for reading obviously).
    893893 *
     894 * @param   stack
    894895 * @param   rstrSrcPath         The source file to open.
    895896 * @param   pszManifestEntry    The manifest entry of the source file.  This is
    … …  
    993994/**
    994995 *
     996 * @param   stack               Import stack.
     997 * @param   rstrSrcPath         Source path.
     998 * @param   rstrDstPath         Destination path.
    995999 * @param   pszManifestEntry    The manifest entry of the source file.  This is
    9961000 *                              used when constructing our manifest using a pass
    … …  
    10411045/**
    10421046 *
     1047 * @param   stack
     1048 * @param   rstrSrcPath
     1049 * @param   rstrDstPath
    10431050 * @param   pszManifestEntry    The manifest entry of the source file.  This is
    10441051 *                              used when constructing our manifest using a pass
    … …  
    19881995 * 1) from the public Appliance::ImportMachines().
    19891996 *
    1990  * @param aLocInfo
    1991  * @param aProgress
     1997 * @param locInfo
     1998 * @param progress
    19921999 * @return
    19932000 */
    … …  
    23642371            lControllerPort = (long)ulAddressOnParent;
    23652372            lDevice = (long)0;
    2366         break;
     2373            break;
    23672374
    23682375        case ovf::HardDiskController::SCSI:
    … …  
    23742381            lControllerPort = (long)ulAddressOnParent;
    23752382            lDevice = (long)0;
     2383            break;
    23762384        }
    2377         break;
    23782385
    23792386        default: break;
    … …  
    34483455 *  4)  Create the VirtualBox machine with the modfified machine config.
    34493456 *
    3450  * @param config
    3451  * @param pNewMachine
    3452  * @param stack
     3457 * @param   vsdescThis
     3458 * @param   pReturnNewMachine
     3459 * @param   stack
    34533460 */
    34543461void Appliance::i_importVBoxMachine(ComObjPtr<VirtualSystemDescription> &vsdescThis,

  • trunk/src/VBox/Main/src-server/HostDnsService.h

    r62485 r65088  
    116116};
    117117
    118 # ifdef RT_OS_DARWIN
     118# if defined(RT_OS_DARWIN) || defined(DOXYGEN_RUNNING)
    119119class HostDnsServiceDarwin : public HostDnsMonitor
    120120{
    … …  
    135135};
    136136# endif
    137 # ifdef RT_OS_WINDOWS
     137# if defined(RT_OS_WINDOWS) || defined(DOXYGEN_RUNNING)
    138138class HostDnsServiceWin : public HostDnsMonitor
    139139{
    … …  
    155155};
    156156# endif
    157 # if defined(RT_OS_SOLARIS) || defined(RT_OS_LINUX) || defined(RT_OS_OS2) || defined(RT_OS_FREEBSD)
     157# if defined(RT_OS_SOLARIS) || defined(RT_OS_LINUX) || defined(RT_OS_OS2) || defined(RT_OS_FREEBSD) \
     158    || defined(DOXYGEN_RUNNING)
    158159class HostDnsServiceResolvConf: public HostDnsMonitor
    159160{
    … …  
    176177    Data *m;
    177178};
    178 #  if defined(RT_OS_SOLARIS)
     179#  if defined(RT_OS_SOLARIS) || defined(DOXYGEN_RUNNING)
    179180/**
    180181 * XXX: https://blogs.oracle.com/praks/entry/file_events_notification
    … …  
    190191};
    191192
    192 #  elif defined(RT_OS_LINUX)
     193#  endif
     194#  if defined(RT_OS_LINUX) || defined(DOXYGEN_RUNNING)
    193195class HostDnsServiceLinux : public HostDnsServiceResolvConf
    194196{
    … …  
    205207};
    206208
    207 #  elif defined(RT_OS_FREEBSD)
     209#  endif
     210#  if defined(RT_OS_FREEBSD) || defined(DOXYGEN_RUNNING)
    208211class HostDnsServiceFreebsd: public HostDnsServiceResolvConf
    209212{
    … …  
    216219};
    217220
    218 #  elif defined(RT_OS_OS2)
     221#  endif
     222#  if defined(RT_OS_OS2) || defined(DOXYGEN_RUNNING)
    219223class HostDnsServiceOs2 : public HostDnsServiceResolvConf
    220224{

  • trunk/src/VBox/Main/src-server/HostImpl.cpp

    r63563 r65088  
    11541154 *
    11551155 * @returns COM status code
    1156  * @param   os address of result variable
     1156 * @param   aOperatingSystem result variable
    11571157 */
    11581158HRESULT Host::getOperatingSystem(com::Utf8Str &aOperatingSystem)

  • trunk/src/VBox/Main/src-server/HostNetworkInterfaceImpl.cpp

    r62485 r65088  
    6666 * @param   aInterfaceName name of the network interface
    6767 * @param   aGuid GUID of the host network interface
     68 * @param   ifType interface type
    6869 */
    6970HRESULT HostNetworkInterface::init(Bstr aInterfaceName, Bstr aShortName, Guid aGuid, HostNetworkInterfaceType_T ifType)
    … …  
    363364
    364365/**
    365  * Returns the IP V6 network mask of the host network interface.
    366  *
    367  * @returns COM status code
    368  * @param   aIPV6Mask address of result pointer
     366 * Returns the IP V6 network mask prefix length of the host network interface.
     367 *
     368 * @returns COM status code
     369 * @param   aIPV6NetworkMaskPrefixLength address of result pointer
    369370 */
    370371HRESULT HostNetworkInterface::getIPV6NetworkMaskPrefixLength(ULONG *aIPV6NetworkMaskPrefixLength)

  • trunk/src/VBox/Main/src-server/SnapshotImpl.cpp

    r65063 r65088  
    639639/**
    640640 * Internal implementation for Snapshot::updateSavedStatePaths (below).
    641  * @param aOldPath
    642  * @param aNewPath
     641 * @param   strOldPath
     642 * @param   strNewPath
    643643 */
    644644void Snapshot::i_updateSavedStatePathsImpl(const Utf8Str &strOldPath,
    … …  
    714714 *  Intended to be called by Machine::openConfigLoader() only.
    715715 *
    716  *  @param aOldPath old path (full)
    717  *  @param aNewPath new path (full)
     716 *  @param  strOldPath old path (full)
     717 *  @param  strNewPath new path (full)
    718718 *
    719719 *  @note Locks the machine (for the snapshots tree) +  this object + children for writing.
    720720 */
    721721void Snapshot::i_updateSavedStatePaths(const Utf8Str &strOldPath,
    722                                       const Utf8Str &strNewPath)
     722                                       const Utf8Str &strNewPath)
    723723{
    724724    LogFlowThisFunc(("aOldPath={%s} aNewPath={%s}\n", strOldPath.c_str(), strNewPath.c_str()));
    … …  
    18581858 * @note Locks VirtualBox and this object for writing.
    18591859 *
    1860  * @param aSuccess Whether Console was successful with the client-side snapshot things.
     1860 * @param   task
     1861 * @param   alock
     1862 * @param   aSuccess    Whether Console was successful with the client-side
     1863 *                      snapshot things.
    18611864 * @return
    18621865 */
    … …  
    26172620 * @note Locks the machine + the snapshot + the media tree for writing!
    26182621 *
    2619  * @param pTask Task data.
     2622 * @param task Task data.
    26202623 */
    26212624void SessionMachine::i_deleteSnapshotHandler(DeleteSnapshotTask &task)

  • trunk/src/VBox/Main/src-server/USBDeviceFilterImpl.cpp

    r63174 r65088  
    3939 *  @param  aFilter     The filter.
    4040 *  @param  aIdx        The field index.
    41  *  @param  aStr        The output string.
     41 *  @param  rstrOut     The output string.
    4242 */
    4343static void i_usbFilterFieldToString(PCUSBFILTER aFilter, USBFILTERIDX aIdx, Utf8Str &rstrOut)

  • trunk/src/VBox/Main/src-server/USBProxyBackend.cpp

    r62485 r65088  
    559559 *
    560560 * @returns Pointer to the head of the sorted doubly linked list.
    561  * @param   aDevices        Head pointer (can be both singly and doubly linked list).
     561 * @param   pDevices        Head pointer (can be both singly and doubly linked list).
    562562 */
    563563static PUSBDEVICE sortDevices(PUSBDEVICE pDevices)

  • trunk/src/VBox/Main/src-server/USBProxyService.cpp

    r61667 r65088  
    264264 * @param   aMachine        The machine to attach the device to.
    265265 * @param   aId             The UUID of the USB device to capture and attach.
     266 * @param   aCaptureFilename
    266267 *
    267268 * @returns COM status code and error info.
    … …  
    423424 *
    424425 * @param   aMachine        The machine to detach devices from.
     426 * @param   aDone
     427 * @param   aAbnormal
    425428 *
    426429 * @returns COM status code, perhaps with error info.

  • trunk/src/VBox/Main/src-server/VirtualBoxImpl.cpp

    r64972 r65088  
    31883188 *
    31893189 * @param aId Machine UUID to look for.
    3190  * @param aPermitInaccessible If true, inaccessible machines will be found;
     3190 * @param fPermitInaccessible If true, inaccessible machines will be found;
    31913191 *                  if false, this will fail if the given machine is inaccessible.
    31923192 * @param aSetError If true, set errorinfo if the machine is not found.
    … …  
    33493349 * Validates a machine group.
    33503350 *
    3351  * @param aMachineGroup     Machine group.
    3352  * @param fPrimary          Set if this is the primary group.
     3351 * @param aGroup    Machine group.
     3352 * @param fPrimary  Set if this is the primary group.
    33533353 *
    33543354 * @return S_OK or E_INVALIDARG
    … …  
    34523452 * object that matches either of them (not necessarily both) is returned.
    34533453 *
    3454  * @param aLocation     Full location specification. Must not be empty.
     3454 * @param strLocation   Full location specification. Must not be empty.
    34553455 * @param aSetError     If @c true , the appropriate error info is set in case
    34563456 *                      when the hard disk is not found.
    … …  
    37733773 * directory as the current directory.
    37743774 *
    3775  * @param  aPath    Path to calculate the absolute path for.
     3775 * @param  strPath  Path to calculate the absolute path for.
    37763776 * @param  aResult  Where to put the result (used only on success, can be the
    37773777 *                  same Utf8Str instance as passed in @a aPath).
    … …  
    48234823 * directory which is normally unknown.
    48244824 *
    4825  * @param aFileName     Full file name which path is checked/created.
    4826  * @param aCreate       Flag if the path should be created if it doesn't exist.
     4825 * @param strFileName   Full file name which path is checked/created.
     4826 * @param fCreate       Flag if the path should be created if it doesn't exist.
    48274827 *
    48284828 * @return Extended error information on failure to check/create the path.

  • trunk/src/VBox/Main/src-server/darwin/HostDnsServiceDarwin.cpp

    r62485 r65088  
    169169                                                            kStateNetworkGlobalDNSKey);
    170170    /**
    171      * 0:vvl@nb-mbp-i7-2(0)# scutil
    172      * > get State:/Network/Global/DNS
    173      * > d.show
    174      * <dictionary> {
     171     * # scutil
     172     * \> get State:/Network/Global/DNS
     173     * \> d.show
     174     * \<dictionary\> {
    175175     * DomainName : vvl-domain
    176      * SearchDomains : <array> {
     176     * SearchDomains : \<array\> {
    177177     * 0 : vvl-domain
    178178     * 1 : de.vvl-domain.com
    179179     * }
    180      * ServerAddresses : <array> {
     180     * ServerAddresses : \<array\> {
    181181     * 0 : 192.168.1.4
    182182     * 1 : 192.168.1.1

  • trunk/src/VBox/Main/src-server/darwin/NetIf-darwin.cpp

    r62485 r65088  
    540540 * @param   puMbits     Where to store the link speed.
    541541 */
    542 int NetIfGetLinkSpeed(const char * /*pcszIfName*/, uint32_t * /*puMbits*/)
    543 {
     542int NetIfGetLinkSpeed(const char *pcszIfName, uint32_t *puMbits)
     543{
     544    RT_NOREF(pcszIfName, puMbits);
    544545    return VERR_NOT_IMPLEMENTED;
    545546}

  • trunk/src/VBox/Main/src-server/linux/HostHardwareLinux.cpp

    r63677 r65088  
    327327 * @param pcszModel   the product ID string
    328328 * @param pszDesc    where to store the description string (optional)
    329  * @param cchDesc    the size of the buffer in @pszDesc
     329 * @param cchDesc    the size of the buffer in @a pszDesc
    330330 * @param pszUdi     where to store the UDI string (optional)
    331  * @param cchUdi     the size of the buffer in @pszUdi
     331 * @param cchUdi     the size of the buffer in @a pszUdi
    332332 */
    333333/* static */

  • trunk/src/VBox/Main/src-server/os2/USBProxyBackendOs2.cpp

    r62485 r65088  
    7777                }
    7878
    79                 LogRel(("USBProxyServiceOs2: failed to register change notification, rc=%d\n", rc));
     79                LogRel(("USBProxyBackendOs2: failed to register change notification, rc=%d\n", rc));
    8080            }
    8181            else
    82                 LogRel(("USBProxyServiceOs2: failed to load usbcalls\n"));
     82                LogRel(("USBProxyBackendOs2: failed to load usbcalls\n"));
    8383
    8484            DosFreeModule(mhmod);
    8585        }
    8686        else
    87             LogRel(("USBProxyServiceOs2: failed to load usbcalls, rc=%d\n", rc));
     87            LogRel(("USBProxyBackendOs2: failed to load usbcalls, rc=%d\n", rc));
    8888        mhmod = NULLHANDLE;
    8989    }
    … …  
    9999 * Stop all service threads and free the device chain.
    100100 */
    101 USBProxyServiceOs2::~USBProxyServiceOs2()
     101USBProxyBackendOs2::~USBProxyBackendOs2()
    102102{
    103103    LogFlowThisFunc(("\n"));
    … …  
    128128
    129129
    130 int USBProxyServiceOs2::captureDevice(HostUSBDevice *aDevice)
     130int USBProxyBackendOs2::captureDevice(HostUSBDevice *aDevice)
    131131{
    132132    AssertReturn(aDevice, VERR_GENERAL_FAILURE);
    … …  
    147147
    148148
    149 int USBProxyServiceOs2::releaseDevice(HostUSBDevice *aDevice)
     149int USBProxyBackendOs2::releaseDevice(HostUSBDevice *aDevice)
    150150{
    151151    AssertReturn(aDevice, VERR_GENERAL_FAILURE);
    … …  
    166166
    167167
    168 bool USBProxyServiceOs2::updateDeviceState(HostUSBDevice *aDevice, PUSBDEVICE aUSBDevice, bool *aRunFilters,
     168bool USBProxyBackendOs2::updateDeviceState(HostUSBDevice *aDevice, PUSBDEVICE aUSBDevice, bool *aRunFilters,
    169169                                           SessionMachine **aIgnoreMachine)
    170170{
    … …  
    176176
    177177
    178 int USBProxyServiceOs2::wait(RTMSINTERVAL aMillies)
     178int USBProxyBackendOs2::wait(RTMSINTERVAL aMillies)
    179179{
    180180    int rc = DosWaitEventSem(mhev, aMillies);
    … …  
    183183
    184184
    185 int USBProxyServiceOs2::interruptWait(void)
     185int USBProxyBackendOs2::interruptWait(void)
    186186{
    187187    int rc = DosPostEventSem(mhev);
    … …  
    193193#include <stdio.h>
    194194
    195 PUSBDEVICE USBProxyServiceOs2::getDevices(void)
     195PUSBDEVICE USBProxyBackendOs2::getDevices(void)
    196196{
    197197    /*

  • trunk/src/VBox/Main/webservice/vboxweb.cpp

    r64012 r65088  
    15361536 *
    15371537 * @param soap
    1538  * @param str
     1538 * @param pcsz
    15391539 * @param extype
    15401540 * @param ex
    … …  
    16071607 * Return a safe C++ string from the given COM UUID,
    16081608 * without crashing if the UUID is empty.
    1609  * @param bstr
     1609 * @param uuid
    16101610 * @return
    16111611 */
    … …  
    17981798 *
    17991799 * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
    1800  *
    1801  * @param username
    1802  * @param password
    18031800 */
    18041801WebServiceSession::WebServiceSession()
    … …  
    19891986 * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
    19901987 *
    1991  * @param pcu pointer to a COM object.
     1988 * @param pObject pointer to a COM object.
    19921989 * @return The existing ManagedObjectRef that represents the COM object, or NULL if there's none yet.
    19931990 */
    … …  
    23642361 * client to clean up itself.
    23652362 *
    2366  * @param
    2367  * @param vbox__IWebsessionManager_USCORElogon
    2368  * @param vbox__IWebsessionManager_USCORElogonResponse
     2363 * @param soap
     2364 * @param req
     2365 * @param resp
    23692366 * @return
    23702367 */
    … …  
    24542451 * hard-coded implementation for IWebsessionManager::logoff.
    24552452 *
    2456  * @param
    2457  * @param vbox__IWebsessionManager_USCORElogon
    2458  * @param vbox__IWebsessionManager_USCORElogonResponse
     2453 * @param req
     2454 * @param resp
    24592455 * @return
    24602456 */

  • trunk/src/VBox/Main/xml/Settings.cpp

    r65082 r65088  
    876876 * For pre-1.4 files, this gets called with the \<DiskRegistry\> chunk instead.
    877877 *
    878  * @param elmMediaRegistry
     878 * @param   elmMediaRegistry
     879 * @param   mr
    879880 */
    880881void ConfigFileBase::readMediaRegistry(const xml::ElementNode &elmMediaRegistry,
    … …  
    18181819 * from both MainConfigFile (for host filters) and MachineConfigFile (for machine
    18191820 * filters).
    1820  * @param elmDeviceFilters
     1821 * @param elmDeviceSources
    18211822 * @param ll
    18221823 */
    … …  
    18631864 * variables contain meaningful values (either from the file or defaults).
    18641865 *
    1865  * @param strFilename
     1866 * @param pstrFilename
    18661867 */
    18671868MainConfigFile::MainConfigFile(const Utf8Str *pstrFilename)
    … …  
    45714572 * for earlier versions.
    45724573 *
    4573  * @param elmStorageControllers
     4574 * @param   elmStorageControllers
     4575 * @param   strg
    45744576 */
    45754577void MachineConfigFile::readStorageControllers(const xml::ElementNode &elmStorageControllers,

  • trunk/src/VBox/Main/xml/ovfreader.cpp

    r63563 r65088  
    120120 * and handles the contained child elements (which can be "Section" or "Content" elements).
    121121 *
    122  * @param pcszPath Path spec of the XML file, for error messages.
    123  * @param pReferencesElement "References" element from OVF, for looking up file specifications; can be NULL if no such element is present.
     122 * @param pReferencesElem "References" element from OVF, for looking up file specifications;
     123 *                       can be NULL if no such element is present.
    124124 * @param pCurElem Element whose children are to be analyzed here.
    125125 * @return
    … …  
    295295 * Gets called indirectly from IAppliance::read().
    296296 *
    297  * @param pcszPath Path spec of the XML file, for error messages.
    298  * @param pSectionElem Section element for which this helper is getting called.
    299297 * @return
    300298 */
    … …  
    322320 * Gets called indirectly from IAppliance::read().
    323321 *
    324  * @param pcszPath
    325  * @param pContentElem
     322 * @param pelmVirtualSystem
    326323 * @return
    327324 */
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