VirtualBox

Changeset 65088 in vbox for trunk/src/VBox/Main/include


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

Main: doxygen fixes

Location:
trunk/src/VBox/Main/include
Files:
13 edited

Legend:

Unmodified
Added
Removed

  • 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
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