Changeset 37624 in vbox for trunk/src/VBox/Main/src-server/linux

Timestamp:

Jun 24, 2011 8:57:35 AM (14 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

72470

Message:

Main/USB/linux: fix some doxygen

File:

• trunk/src/VBox/Main/src-server/linux/USBGetDevices.cpp (modified) (4 diffs)

trunk/src/VBox/Main/src-server/linux/USBGetDevices.cpp

@@ -1481 +1481 @@
 # define getDevicesFromUsbfs testGetUsbfsDevices
 
+/**
+ * Specify the list of devices that will appear to be available through
+ * usbfs during unit testing (of USBProxyLinuxGetDevices)
+ * @param  pacszDeviceAddresses  NULL terminated array of usbfs device addresses
+ */
 void TestUSBSetAvailableUsbfsDevices(const char **pacszDeviceAddresses)
 {
@@ -1500 +1505 @@
 # define access testAccess
 
+/**
+ * Specify the list of files that access will report as accessible (at present
+ * we only do accessible or not accessible) during unit testing (of
+ * USBProxyLinuxGetDevices)
+ * @param  pacszAccessibleFiles  NULL terminated array of file paths to be
+ *                               reported accessible
+ */
 void TestUSBSetAccessibleFiles(const char **pacszAccessibleFiles)
 {
@@ -1656 +1668 @@
 #endif
 
+/**
+ * Check whether a USB device tree root is usable
+ * @param pcszRoot        the path to the root of the device tree
+ * @param fIsDeviceNodes  whether this is a device node (or usbfs) tree
+ * @note  returns a pointer into a static array so it will stay valid
+ */
 bool USBProxyLinuxCheckDeviceRoot(const char *pcszRoot, bool fIsDeviceNodes)
 {
@@ -1689 +1707 @@
 #endif
 
+/**
+ * Get the list of USB devices supported by the system.  Should be freed using
+ * @a deviceFree or something equivalent.
+ * @param pcszDevicesRoot  the path to the root of the device tree
+ * @param fUseSysfs        whether to use sysfs (or usbfs) for enumeration
+ */
 PUSBDEVICE USBProxyLinuxGetDevices(const char *pcszDevicesRoot,
                                    bool fUseSysfs)