Consistent parameter name for device type

Use the same formal parameter name `type` for all the `get_devices` member functions.
KhronosGroup · Jun 25, 2024 · 576f274 · 576f274
1 parent 89cd50c
commit 576f274
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/adoc/chapters/programming_interface.adoc b/adoc/chapters/programming_interface.adoc
@@ -1719,12 +1719,12 @@ a@
 [source]
 ----
 static std::vector<device>
-get_devices(info::device_type deviceType = info::device_type::all)
+get_devices(info::device_type type = info::device_type::all)
 ----
    a@ Returns a [code]#std::vector# containing all the
       <<root-device, root devices>> from all <<backend, SYCL backends>>
       available in the system which have the device type encapsulated by
-      [code]#deviceType#.
+      [code]#type#.
 
 |====
 

diff --git a/adoc/headers/device.h b/adoc/headers/device.h
@@ -47,6 +47,6 @@ class device {
   create_sub_devices(info::partition_affinity_domain affinityDomain) const;
 
   static std::vector<device>
-  get_devices(info::device_type deviceType = info::device_type::all);
+  get_devices(info::device_type type = info::device_type::all);
 };
 } // namespace sycl
diff --git a/adoc/headers/platform.h b/adoc/headers/platform.h
@@ -14,7 +14,7 @@ class platform {
   backend get_backend() const noexcept;
 
   std::vector<device>
-      get_devices(info::device_type = info::device_type::all) const;
+      get_devices(info::device_type type = info::device_type::all) const;
 
   template <typename Param> typename Param::return_type get_info() const;