Docs: change parameter name to match intention.

Document that  means exclude-read-only and change the
name to match. It was already named excludeReadOnly in the
parted backend.
This commit is contained in:
Adriaan de Groot 2017-10-03 04:45:44 -04:00
parent 80c5cb5a1f
commit 98caf84424
1 changed files with 5 additions and 1 deletions

View File

@ -87,10 +87,14 @@ public:
/**
* Scan for devices in the system.
* @param excludeReadOnly when true, devices that are read-only
* according to the kernel are left out of the list.
* When false (the default) all devices, writable or
* not, including CD ROM devices, are returned.
* @return a QList of pointers to Device instances. The caller is responsible
* for deleting these objects.
*/
virtual QList<Device*> scanDevices(bool excludeLoop = false) = 0;
virtual QList<Device*> scanDevices(bool excludeReadOnly = false) = 0;
/**
* Scan a single device in the system.