VirtualBox

Changeset 65088 in vbox for trunk/src/VBox/Main/src-server


Ignore:
Timestamp:
Jan 3, 2017 8:52:49 PM (8 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
112590
Message:

Main: doxygen fixes

Location:
trunk/src/VBox/Main/src-server
Files:
14 edited

Legend:

Unmodified
Added
Removed

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