Changeset 65063 in vbox for trunk/src

Timestamp:

Jan 3, 2017 11:15:49 AM (8 years ago)

Author:

vboxsync

Message:

Main: doxygen fixes

Location:

trunk/src/VBox/Main

Files:

• include/USBProxyBackend.h (modified) (1 diff)
• src-server/AudioAdapterImpl.cpp (modified) (2 diffs)
• src-server/BIOSSettingsImpl.cpp (modified) (2 diffs)
• src-server/MachineImpl.cpp (modified) (3 diffs)
• src-server/NetworkAdapterImpl.cpp (modified) (2 diffs)
• src-server/ParallelPortImpl.cpp (modified) (2 diffs)
• src-server/SerialPortImpl.cpp (modified) (2 diffs)
• src-server/SnapshotImpl.cpp (modified) (1 diff)
• src-server/USBDeviceFiltersImpl.cpp (modified) (2 diffs)
• src-server/VRDEServerImpl.cpp (modified) (2 diffs)

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

@@ -225 +225 @@
     /** The root of usbfs. */
     Utf8Str mDevicesRoot;
-    /** Whether we're using <mUsbfsRoot>/devices or /sys/whatever. */
+    /** Whether we're using \<mUsbfsRoot\>/devices or /sys/whatever. */
     bool mUsingUsbfsDevices;
     /** Number of 500ms polls left to do. See usbDeterminState for details. */

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

@@ -468 +468 @@
  *  May be called once right after this object creation.
  *
- *  @param aMachineNode <Machine> node.
+ *  @param data Configuration settings.
  *
  *  @note Locks this object for writing.
@@ -497 +497 @@
  *  Saves settings to the given machine node.
  *
- *  @param aMachineNode <Machine> node.
+ *  @param data Configuration settings.
  *
  *  @note Locks this object for reading.

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

@@ -494 +494 @@
  *  May be called once right after this object creation.
  *
- *  @param aMachineNode <Machine> node.
+ *  @param data Configuration settings.
  *
  *  @note Locks this object for writing.
@@ -514 +514 @@
  *  Saves settings to the given machine node.
  *
- *  @param aMachineNode <Machine> node.
+ *  @param data Configuration settings.
  *
  *  @note Locks this object for reading.

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

@@ -8812 +8812 @@
  *  Recursively loads all snapshots starting from the given.
  *
- *  @param aNode            <Snapshot> node.
+ *  @param data             snapshot settings.
  *  @param aCurSnapshotId   Current snapshot ID from the settings file.
  *  @param aParentSnapshot  Parent snapshot.
@@ -9240 +9240 @@
  *  Called from i_loadMachineDataFromSettings() for the storage controller data, including media.
  *
- * @param data
- * @param puuidRegistry media registry ID to set media to or NULL; see Machine::i_loadMachineDataFromSettings()
- * @param puuidSnapshot
+ * @param data          storage settings.
+ * @param puuidRegistry media registry ID to set media to or NULL;
+ *                      see Machine::i_loadMachineDataFromSettings()
+ * @param puuidSnapshot snapshot ID
  * @return
  */
@@ -10507 +10508 @@
  *  Saves the storage controller configuration.
  *
- *  @param aNode    <StorageControllers> node to save the VM hardware configuration to.
+ *  @param data    storage settings.
  */
 HRESULT Machine::i_saveStorageControllers(settings::Storage &data)

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

@@ -1015 +1015 @@
  *  May be called once right after this object creation.
  *
- *  @param aAdapterNode <Adapter> node.
+ *  @param bwctl bandwidth control object.
+ *  @param data  Configuration settings.
  *
  *  @note Locks this object for writing.
@@ -1071 +1072 @@
  *  Note that the given Adapter node is completely empty on input.
  *
- *  @param aAdapterNode <Adapter> node.
+ *  @param data Configuration settings.
  *
  *  @note Locks this object for reading.

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

@@ -371 +371 @@
  *  May be called once right after this object creation.
  *
- *  @param aPortNode <Port> node.
+ *  @param data Configuration settings.
  *
  *  @note Locks this object for writing.
@@ -393 +393 @@
  *  Note that the given Port node is completely empty on input.
  *
- *  @param  <data> node.
+ *  @param  data Configuration settings.
  *
  *  @note Locks this object for reading.

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

@@ -493 +493 @@
  *  May be called once right after this object creation.
  *
- *  @param aPortNode <Port> node.
+ *  @param data Configuration settings.
  *
  *  @note Locks this object for writing.
@@ -516 +516 @@
  *  Note that the given Port node is completely empty on input.
  *
- *  @param aPortNode <Port> node.
+ *  @param data Configuration settings.
  *
  *  @note Locks this object for reading.

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

@@ -1110 +1110 @@
  *  Initializes the SnapshotMachine object when loading from the settings file.
  *
- *  @param aMachine machine the snapshot belongs to
- *  @param aHWNode          <Hardware> node
- *  @param aHDAsNode        <HardDiskAttachments> node
+ *  @param aMachine         machine the snapshot belongs to
+ *  @param hardware         hardware settings
+ *  @param pDbg             debuging settings
+ *  @param pAutoStart       autostart settings
  *  @param aSnapshotId      snapshot ID of this snapshot machine
  *  @param aStateFilePath   file where the execution state is saved

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

@@ -480 +480 @@
  *  May be called once right after this object creation.
  *
- *  @param aMachineNode <Machine> node.
+ *  @param data Configuration settings.
  *
  *  @note Does not lock "this" as Machine::loadHardware, which calls this, does not lock either.
@@ -523 +523 @@
  *  Saves settings to the given machine node.
  *
- *  @param aMachineNode <Machine> node.
+ *  @param data Configuration settings.
  *
  *  @note Locks this object for reading.

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

@@ -188 +188 @@
  *  May be called once right after this object creation.
  *
- *  @param aMachineNode <Machine> node.
+ *  @param data Configuration settings.
  *
  *  @note Locks this object for writing.
@@ -208 +208 @@
  *  Saves settings to the given machine node.
  *
- *  @param aMachineNode <Machine> node.
+ *  @param data Configuration settings.
  *
  *  @note Locks this object for reading.