From 98caf84424906adbe04a4ce76078df6f02659bd7 Mon Sep 17 00:00:00 2001 From: Adriaan de Groot Date: Tue, 3 Oct 2017 04:45:44 -0400 Subject: [PATCH] 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. --- src/backend/corebackend.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/backend/corebackend.h b/src/backend/corebackend.h index 3a3d1e8..4210965 100644 --- a/src/backend/corebackend.h +++ b/src/backend/corebackend.h @@ -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 scanDevices(bool excludeLoop = false) = 0; + virtual QList scanDevices(bool excludeReadOnly = false) = 0; /** * Scan a single device in the system.