Changeset 65103 in vbox for trunk/src/VBox/Main

Timestamp:

Jan 4, 2017 12:08:18 PM (8 years ago)

Author:

vboxsync

Message:

Main: doxygen fixes

Location:

trunk/src/VBox/Main

Files:

• include/MediumAttachmentImpl.h (modified) (1 diff)
• include/ProgressImpl.h (modified) (1 diff)
• src-all/ProgressImpl.cpp (modified) (3 diffs)
• src-client/ConsoleImpl.cpp (modified) (1 diff)
• src-client/MachineDebuggerImpl.cpp (modified) (15 diffs)
• src-client/MouseImpl.cpp (modified) (8 diffs)
• src-client/PCIRawDevImpl.cpp (modified) (1 diff)
• src-client/SessionImpl.cpp (modified) (1 diff)
• src-server/ApplianceImpl.cpp (modified) (3 diffs)
• src-server/MediumAttachmentImpl.cpp (modified) (1 diff)
• src-server/MediumImpl.cpp (modified) (4 diffs)
• src-server/NetworkAdapterImpl.cpp (modified) (2 diffs)
• src-server/ParallelPortImpl.cpp (modified) (1 diff)
• src-server/SerialPortImpl.cpp (modified) (1 diff)
• src-server/SnapshotImpl.cpp (modified) (4 diffs)
• src-server/StorageControllerImpl.cpp (modified) (2 diffs)
• src-server/SystemPropertiesImpl.cpp (modified) (1 diff)
• src-server/USBControllerImpl.cpp (modified) (1 diff)
• src-server/USBDeviceFilterImpl.cpp (modified) (4 diffs)
• src-server/USBProxyService.cpp (modified) (2 diffs)
• src-server/VFSExplorerImpl.cpp (modified) (2 diffs)
• src-server/VirtualBoxImpl.cpp (modified) (2 diffs)
• webservice/vboxweb.cpp (modified) (1 diff)

trunk/src/VBox/Main/include/MediumAttachmentImpl.h

@@ -39 +39 @@
                  LONG aDevice,
                  DeviceType_T aType,
-                 bool fImplicit,
-                 bool fPassthrough,
-                 bool fTempEject,
-                 bool fNonRotational,
-                 bool fDiscard,
-                 bool fHotPluggable,
+                 bool aImplicit,
+                 bool aPassthrough,
+                 bool aTempEject,
+                 bool aNonRotational,
+                 bool aDiscard,
+                 bool aHotPluggable,
                  const Utf8Str &strBandwidthGroup);
     HRESULT initCopy(Machine *aParent, MediumAttachment *aThat);

trunk/src/VBox/Main/include/ProgressImpl.h

@@ -79 +79 @@
      * @param aCancelable
      * @param cOperations
-     * @param bstrFirstOperationDescription
+     * @param aFirstOperationDescription
      * @return
      */

trunk/src/VBox/Main/src-all/ProgressImpl.cpp

@@ -139 +139 @@
  * @param ulTotalOperationsWeight Total weight of operations; must be the sum of ulFirstOperationWeight and
  *                          what is later passed with each subsequent setNextOperation() call.
- * @param bstrFirstOperationDescription Description of the first operation.
+ * @param aFirstOperationDescription Description of the first operation.
  * @param ulFirstOperationWeight Weight of first sub-operation.
  */
@@ -407 +407 @@
  * @param aResultCode   Operation result (error) code, must not be S_OK.
  * @param aIID          IID of the interface that defines the error.
- * @param aComponent    Name of the component that generates the error.
+ * @param pcszComponent Name of the component that generates the error.
  * @param aText         Error message (must not be null), an RTStrPrintf-like
  *                      format string in UTF-8 encoding.
@@ -781 +781 @@
  * the next operation. The operation percentage is reset to 0.
  *
- * @param aOperationDescription     Description of the next operation.
+ * @param aNextOperationDescription  Description of the next operation.
+ * @param aNextOperationsWeight     Weight of the next operation.
  *
  * @note The current operation must not be the last one.

trunk/src/VBox/Main/src-client/ConsoleImpl.cpp

@@ -4826 +4826 @@
  * @returns COM status code.
  *
- * @parma   pUVM                The VM handle (caller hold this safely).
+ * @param   pUVM                The VM handle (caller hold this safely).
  * @param   pszDevice           The PDM device name.
  * @param   uInstance           The PDM device instance.

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

@@ -143 +143 @@
  *
  * @returns COM status code
- * @param   a_fEnable       The new state.
+ * @param   aSingleStep     The new state.
  */
 HRESULT MachineDebugger::setSingleStep(BOOL aSingleStep)
@@ -224 +224 @@
  *
  * @returns COM status code
- * @param   a_fEnabled address of result variable
+ * @param   aRecompileUser  address of result variable
  */
 HRESULT MachineDebugger::getRecompileUser(BOOL *aRecompileUser)
@@ -235 +235 @@
  *
  * @returns COM status
- * @param   aEnable new user mode code recompile flag.
+ * @param   aRecompileUser  new user mode code recompile flag.
  */
 HRESULT MachineDebugger::setRecompileUser(BOOL aRecompileUser)
@@ -247 +247 @@
  *
  * @returns COM status code
- * @param   aEnabled address of result variable
+ * @param   aRecompileSupervisor    address of result variable
  */
 HRESULT MachineDebugger::getRecompileSupervisor(BOOL *aRecompileSupervisor)
@@ -258 +258 @@
  *
  * @returns COM status code
- * @param   aEnable new recompile supervisor code flag
+ * @param   aRecompileSupervisor    new recompile supervisor code flag
  */
 HRESULT MachineDebugger::setRecompileSupervisor(BOOL aRecompileSupervisor)
@@ -270 +270 @@
  *
  * @returns COM status code
- * @param   aEnabled    Address of result variable.
+ * @param   aExecuteAllInIEM    Address of result variable.
  */
 HRESULT MachineDebugger::getExecuteAllInIEM(BOOL *aExecuteAllInIEM)
@@ -281 +281 @@
  *
  * @returns COM status code
- * @param   aEnable     New setting.
+ * @param   aExecuteAllInIEM    New setting.
  */
 HRESULT MachineDebugger::setExecuteAllInIEM(BOOL aExecuteAllInIEM)
@@ -293 +293 @@
  *
  * @returns COM status code
- * @param   aEnabled address of result variable
+ * @param   aPATMEnabled    address of result variable
  */
 HRESULT MachineDebugger::getPATMEnabled(BOOL *aPATMEnabled)
@@ -314 +314 @@
  *
  * @returns COM status code
- * @param   aEnable new patch manager enabled flag
+ * @param   aPATMEnabled    new patch manager enabled flag
  */
 HRESULT MachineDebugger::setPATMEnabled(BOOL aPATMEnabled)
@@ -349 +349 @@
  *
  * @returns COM status code
- * @param   aEnabled address of result variable
+ * @param   aCSAMEnabled    address of result variable
  */
 HRESULT MachineDebugger::getCSAMEnabled(BOOL *aCSAMEnabled)
@@ -371 +371 @@
  *
  * @returns COM status code
- * @param   aEnable new code scanner enabled flag
+ * @param   aCSAMEnabled    new code scanner enabled flag
  */
 HRESULT MachineDebugger::setCSAMEnabled(BOOL aCSAMEnabled)
@@ -593 +593 @@
  *
  * @returns COM status code
- * @param   aEnabled address of result variable
+ * @param   aHWVirtExUXEnabled  address of result variable
  */
 HRESULT MachineDebugger::getHWVirtExUXEnabled(BOOL *aHWVirtExUXEnabled)
@@ -675 +675 @@
  *
  * @returns COM status code
- * @param   aEnabled address of result variable
+ * @param   aPAEEnabled     address of result variable.
  */
 HRESULT MachineDebugger::getPAEEnabled(BOOL *aPAEEnabled)
@@ -699 +699 @@
  *
  * @returns COM status code.
- * @param   a_puPct      Where to store the rate.
+ * @param   aVirtualTimeRate    Where to store the rate.
  */
 HRESULT MachineDebugger::getVirtualTimeRate(ULONG *aVirtualTimeRate)
@@ -714 +714 @@
 
 /**
- * Returns the current virtual time rate.
+ * Set the virtual time rate.
  *
  * @returns COM status code.
- * @param   aPct     Where to store the rate.
+ * @param   aVirtualTimeRate    The new rate.
  */
 HRESULT MachineDebugger::setVirtualTimeRate(ULONG aVirtualTimeRate)

trunk/src/VBox/Main/src-client/MouseImpl.cpp

@@ -367 +367 @@
  *
  * @returns COM status code
- * @param absoluteSupported address of result variable
+ * @param aAbsoluteSupported address of result variable
  */
 HRESULT Mouse::getAbsoluteSupported(BOOL *aAbsoluteSupported)
@@ -380 +380 @@
  *
  * @returns COM status code
- * @param relativeSupported address of result variable
+ * @param aRelativeSupported address of result variable
  */
 HRESULT Mouse::getRelativeSupported(BOOL *aRelativeSupported)
@@ -393 +393 @@
  *
  * @returns COM status code
- * @param multiTouchSupported address of result variable
+ * @param aMultiTouchSupported address of result variable
  */
 HRESULT Mouse::getMultiTouchSupported(BOOL *aMultiTouchSupported)
@@ -406 +406 @@
  *
  * @returns COM status code
- * @param pfNeedsHostCursor address of result variable
+ * @param aNeedsHostCursor address of result variable
  */
 HRESULT Mouse::getNeedsHostCursor(BOOL *aNeedsHostCursor)
@@ -736 +736 @@
  *
  * @returns COM status code
- * @param dx          X movement
- * @param dy          Y movement
- * @param dz          Z movement
- * @param fButtons    The mouse button state
+ * @param dx            X movement.
+ * @param dy            Y movement.
+ * @param dz            Z movement.
+ * @param dw            Mouse wheel movement.
+ * @param aButtonState  The mouse button state.
  */
 HRESULT Mouse::putMouseEvent(LONG dx, LONG dy, LONG dz, LONG dw,
@@ -837 +838 @@
  *
  * @returns COM status code
- * @param x          X position (pixel), starting from 1
- * @param y          Y position (pixel), starting from 1
- * @param dz         Z movement
- * @param fButtons   The mouse button state
+ * @param x         X position (pixel), starting from 1
+ * @param y         Y position (pixel), starting from 1
+ * @param dz        Z movement
+ * @param dw        mouse wheel movement
+ * @param aButtonState The mouse button state
  */
 HRESULT Mouse::putMouseEventAbsolute(LONG x, LONG y, LONG dz, LONG dw,
@@ -1048 +1050 @@
 
 /** Check what sort of reporting can be done using the devices currently
- * enabled.  Does not consider the VMM device. */
+ * enabled.  Does not consider the VMM device.
+ *
+ * @param   pfAbs   supports absolute mouse coordinates.
+ * @param   pfRel   supports relative mouse coordinates.
+ * @param   pfMT    supports multitouch.
+ */
 void Mouse::i_getDeviceCaps(bool *pfAbs, bool *pfRel, bool *pfMT)
 {
@@ -1149 +1156 @@
  * A virtual device is notifying us about its current state and capabilities
  */
-DECLCALLBACK(void) Mouse::i_mouseReportModes(PPDMIMOUSECONNECTOR pInterface, bool fRel, bool fAbs, bool fMT)
+DECLCALLBACK(void) Mouse::i_mouseReportModes(PPDMIMOUSECONNECTOR pInterface, bool fRelative,
+                                             bool fAbsolute, bool fMultiTouch)
 {
     PDRVMAINMOUSE pDrv = RT_FROM_MEMBER(pInterface, DRVMAINMOUSE, IConnector);
-    if (fRel)
+    if (fRelative)
         pDrv->u32DevCaps |= MOUSE_DEVCAP_RELATIVE;
     else
         pDrv->u32DevCaps &= ~MOUSE_DEVCAP_RELATIVE;
-    if (fAbs)
+    if (fAbsolute)
         pDrv->u32DevCaps |= MOUSE_DEVCAP_ABSOLUTE;
     else
         pDrv->u32DevCaps &= ~MOUSE_DEVCAP_ABSOLUTE;
-    if (fMT)
+    if (fMultiTouch)
         pDrv->u32DevCaps |= MOUSE_DEVCAP_MULTI_TOUCH;
     else

trunk/src/VBox/Main/src-client/PCIRawDevImpl.cpp

@@ -67 +67 @@
 
 /**
- * @interface_method_impl{PDMIPCIRAWUP,pfnPciDeviceConstructComplete}
+ * @interface_method_impl{PDMIPCIRAWCONNECTOR,pfnDeviceConstructComplete}
  */
 DECLCALLBACK(int) PCIRawDev::drvDeviceConstructComplete(PPDMIPCIRAWCONNECTOR pInterface, const char *pcszName,

trunk/src/VBox/Main/src-client/SessionImpl.cpp

@@ -1090 +1090 @@
  *  @param aFinalRelease    called as a result of FinalRelease()
  *  @param aFromServer      called as a result of Uninitialize()
- *  @param pLockW           The write lock this object is protected with.
+ *  @param aLockW           The write lock this object is protected with.
  *                          Must be acquired already and will be released
  *                          and later reacquired during the unlocking.

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

@@ -373 +373 @@
  * Implementation for IVirtualBox::createAppliance.
  *
- * @param anAppliance IAppliance object created if S_OK is returned.
+ * @param aAppliance IAppliance object created if S_OK is returned.
  * @return S_OK or error.
  */
@@ -392 +392 @@
 /**
  * Appliance COM initializer.
- * @param
+ * @param   aVirtualBox     The VirtualBox object. 
  * @return
  */
@@ -1394 +1394 @@
 /**
  * Public method implementation.
- * @param
+ * @param   aCount
  * @return
  */

trunk/src/VBox/Main/src-server/MediumAttachmentImpl.cpp

@@ -92 +92 @@
  * @param aParent           Machine object.
  * @param aMedium           Medium object.
- * @param aController       Controller the hard disk is attached to.
+ * @param aControllerName   Controller the hard disk is attached to.
  * @param aPort             Port number.
  * @param aDevice           Device number on the port.
+ * @param aType             Device type.
+ * @param aImplicit
  * @param aPassthrough      Whether accesses are directly passed to the host drive.
- * @param aBandwidthLimit   Bandwidth limit in Mbps
+ * @param aTempEject
+ * @param aNonRotational    Whether this medium is non-rotational (aka SSD).
+ * @param aDiscard
+ * @param aHotPluggable     Whether this medium is hot-pluggable.
+ * @param aBandwidthLimit   Bandwidth limit in Mbps.
  */
 HRESULT MediumAttachment::init(Machine *aParent,

trunk/src/VBox/Main/src-server/MediumImpl.cpp

@@ -1074 +1074 @@
  * @param uuidMachineRegistry The registry to which this medium should be added
  *                            (global registry UUID or machine UUID or empty if none).
- * @param deviceType    Device Type.
+ * @param aDeviceType   Device Type.
  */
 HRESULT Medium::init(VirtualBox *aVirtualBox,
@@ -4367 +4367 @@
  * of this media and updates it if necessary to reflect the new location.
  *
- * @param aOldPath  Old path (full).
- * @param aNewPath  New path (full).
+ * @param strOldPath  Old path (full).
+ * @param strNewPath  New path (full).
  *
  * @note Locks this object for writing.
@@ -6072 +6072 @@
  * Used by IAppliance to export disk images.
  *
- * @param aFilename             Filename to create (UTF8).
- * @param aFormat               Medium format for creating @a aFilename.
- * @param aVariant              Which exact image format variant to use
- *                              for the destination image.
- * @param pKeyStore             The optional key store for decrypting the data
- *                              for encrypted media during the export.
- * @param aVDImageIOCallbacks   Pointer to the callback table for a
- *                              VDINTERFACEIO interface. May be NULL.
- * @param aVDImageIOUser        Opaque data for the callbacks.
- * @param aProgress             Progress object to use.
+ * @param aFilename         Filename to create (UTF8).
+ * @param aFormat           Medium format for creating @a aFilename.
+ * @param aVariant          Which exact image format variant to use for the
+ *                          destination image.
+ * @param pKeyStore         The optional key store for decrypting the data for
+ *                          encrypted media during the export.
+ * @param aVDImageIOIf      Pointer to the callback table for a VDINTERFACEIO
+ *                          interface. May be NULL.
+ * @param aVDImageIOUser    Opaque data for the callbacks.
+ * @param aProgress         Progress object to use.
  * @return
  * @note The source format is defined by the Medium instance.
@@ -6511 +6511 @@
  * @note Locks m->pParent for reading. Locks this object for writing.
  *
- * @param fSetImageId Whether to reset the UUID contained in the image file to the UUID in the medium instance data (see SetIDs())
- * @param fSetParentId Whether to reset the parent UUID contained in the image file to the parent
- *                     UUID in the medium instance data (see SetIDs())
+ * @param fSetImageId   Whether to reset the UUID contained in the image file
+ *                      to the UUID in the medium instance data (see SetIDs())
+ * @param fSetParentId  Whether to reset the parent UUID contained in the image
+ *                      file to the parent UUID in the medium instance data (see
+ *                      SetIDs())
+ * @param autoCaller
  * @return
  */

trunk/src/VBox/Main/src-server/NetworkAdapterImpl.cpp

@@ -65 +65 @@
  *
  *  @param aParent  Handle of the parent object.
+ *  @param uSlot    Slot number this network adapter is plugged into.
  */
 HRESULT NetworkAdapter::init(Machine *aParent, ULONG uSlot)
@@ -102 +103 @@
  *  the object passed as an argument.
  *
+ *  @param  aParent     Parent object.
+ *  @param  aThat
  *  @param  aReshare
  *      When false, the original object will remain a data owner.

trunk/src/VBox/Main/src-server/ParallelPortImpl.cpp

@@ -72 +72 @@
  *
  *  @param aParent  Handle of the parent object.
+ *  @param aSlot    Slotnumber this parallel port is plugged into.
  */
 HRESULT ParallelPort::init(Machine *aParent, ULONG aSlot)

trunk/src/VBox/Main/src-server/SerialPortImpl.cpp

@@ -74 +74 @@
  *
  *  @param aParent  Handle of the parent object.
+ *  @param aSlot    Slot number the serial port is plugged into.
  */
 HRESULT SerialPort::init(Machine *aParent, ULONG aSlot)

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

@@ -99 +99 @@
  *  Initializes the instance
  *
+ *  @param  aVirtualBox    VirtualBox object
  *  @param  aId            id of the snapshot
  *  @param  aName          name of the snapshot
@@ -1113 +1114 @@
  *  @param hardware         hardware settings
  *  @param pDbg             debuging settings
- *  @param pAutoStart       autostart settings
+ *  @param pAutostart       autostart settings
  *  @param aSnapshotId      snapshot ID of this snapshot machine
  *  @param aStateFilePath   file where the execution state is saved
@@ -2051 +2052 @@
  * @note Locks mParent + this object for writing.
  *
- * @param pTask Task data.
+ * @param task Task data.
  */
 void SessionMachine::i_restoreSnapshotHandler(RestoreSnapshotTask &task)
@@ -3629 +3630 @@
  * @param aSource       Source hard disk for merge.
  * @param aTarget       Target hard disk for merge.
- * @param aMergeForward Merge direction.
+ * @param fMergeForward Merge direction.
  * @param aParentForTarget New parent if target needs to be reparented.
  * @param aChildrenToReparent Medium lock list with children which have to be

trunk/src/VBox/Main/src-server/StorageControllerImpl.cpp

@@ -83 +83 @@
  * @param aParent       Pointer to our parent object.
  * @param aName         Name of the storage controller.
+ * @param aStorageBus   Type of the storage bus.
  * @param aInstance     Instance number of the storage controller.
+ * @param fBootable     Bootable flag.
  */
 HRESULT StorageController::init(Machine *aParent,
@@ -176 +178 @@
  *  the object passed as an argument.
  *
+ *  @param  aParent     Pointer to our parent object.
+ *  @param  aThat
  *  @param  aReshare
  *      When false, the original object will remain a data owner.

trunk/src/VBox/Main/src-server/SystemPropertiesImpl.cpp

@@ -1175 +1175 @@
  * the "default default" machine folder has changed, and we now require
  * a full path always.
- * @param aPath
+ * @param   strPath
  * @return
  */

trunk/src/VBox/Main/src-server/USBControllerImpl.cpp

@@ -121 +121 @@
  * @param aParent       Pointer to our parent object.
  * @param aPeer         The object to share.
- *  @param  aReshare
+ * @param fReshare
  *      When false, the original object will remain a data owner.
  *      Otherwise, data ownership will be transferred from the original

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

@@ -83 +83 @@
  *  @param  aFilter     The filter.
  *  @param  aIdx        The field index.
- *  @param  aStr        The input string.
- *  @param  aName       The field name for use in the error string.
+ *  @param  aValue      The input string.
  *  @param  aErrStr     Where to return the error string on failure.
  *
@@ -278 +277 @@
  *
  *  @param aParent  Handle of the parent object.
+ *  @param aName    Name of the filter.
  */
 HRESULT USBDeviceFilter::init(USBDeviceFilters *aParent, IN_BSTR aName)
@@ -317 +317 @@
  *  the object passed as an argument.
  *
+ *  @param  aParent  Handle of the parent object.
+ *  @param  aThat
  *  @param  aReshare
  *      When false, the original object will remain a data owner.
@@ -778 +780 @@
  *
  *  @param  aIdx    The field index.
- *  @param  aStr    The new value.
+ *  @param  strNew  The new value.
  *
  *  @return COM status.

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

@@ -543 +543 @@
  *
  * @param   aDevice     The device in question.
- * @param   aUSBDevice  The USB device structure.
+ * @param   pDev        The USB device structure.
  */
 void USBProxyService::i_deviceAdded(ComObjPtr<HostUSBDevice> &aDevice,
@@ -711 +711 @@
  * @returns COM status code (only parameter & state checks will fail).
  * @param   aDevice         The USB device to apply filters to.
+ * @param   llOpenedMachines The list of opened machines.
  * @param   aIgnoreMachine  The machine to ignore filters from (we've just
  *                          detached the device from this machine).

trunk/src/VBox/Main/src-server/VFSExplorerImpl.cpp

@@ -75 +75 @@
 /**
  * VFSExplorer COM initializer.
- * @param
+ * @param   aType       VFS type.
+ * @param   aFilePath   File path.
+ * @param   aHostname   Host name.
+ * @param   aUsername   User name.
+ * @param   aPassword   Password.
+ * @param   aVirtualBox VirtualBox object.
  * @return
  */
@@ -125 +130 @@
 /**
  * Public method implementation.
- * @param
+ * @param   aPath   Where to store the path.
  * @return
  */

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

@@ -666 +666 @@
  * continue to work as before.
  *
- * @param uuidMachineRegistry The UUID of the media registry. This is either the
+ * @param uuidRegistry The UUID of the media registry. This is either the
  *       transient UUID created at VirtualBox startup for the global registry or
  *       a machine ID.
  * @param mediaRegistry The XML settings structure to load, either from VirtualBox.xml
  *       or a machine XML.
+ * @param strMachineFolder The folder of the machine.
  * @return
  */
@@ -3623 +3624 @@
  * @param uuid UUID to search for; must refer to a host drive or an image file or be null.
  * @param fRefresh Whether to refresh the list of host drives in IHost (see Host::getDrives())
+ * @param aSetError
  * @param pMedium out: IMedium object found.
  * @return

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

@@ -2190 +2190 @@
  * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
  *
- * @param strId
- * @param iter
+ * @param   id
+ * @param   pRef
+ * @param   fNullAllowed
  * @return
  */