[SYCL][NFC] Fix doxygen warnings

The warnings are about parameter name mismatch and undocumented
parameters.

Signed-off-by: Alexey Bader <[email protected]>

Author: bader

sycl/include/CL/sycl/device.hpp

@@ -36,7 +36,7 @@ class device {
   /// Constructs a SYCL device instance using the device selected
   /// by the DeviceSelector provided.
   ///
-  /// \param deviceSelector SYCL device selector to be used (see 4.6.1.1).
+  /// \param DeviceSelector SYCL device selector to be used (see 4.6.1.1).
   explicit device(const device_selector &DeviceSelector);
 
   bool operator==(const device &rhs) const { return impl == rhs.impl; }
@@ -53,7 +53,8 @@ class device {
 
   /// Get instance of device
   ///
-  /// \return a valid cl_device_id instance in accordance with the requirements described in 4.3.1.
+  /// \return a valid cl_device_id instance in accordance with the requirements
+  /// described in 4.3.1.
   cl_device_id get() const;
 
   /// Check if device is a host device
@@ -82,52 +83,61 @@ class device {
   /// must encapsulate the OpenCL cl_plaform_id associated with the
   /// underlying OpenCL cl_device_id of this SYCL device. If this SYCL device
   /// is a host device then the SYCL platform must be a host platform.
-  /// The value returned must be equal to that returned by get_info<info::device::platform>().
+  /// The value returned must be equal to that returned by
+  /// get_info<info::device::platform>().
   ///
   /// \return The associated SYCL platform.
   platform get_platform() const;
 
   /// Partition device into sub devices
   ///
   /// Available only when prop is info::partition_property::partition_equally.
-  /// If this SYCL device does not support info::partition_property::partition_equally
-  /// a feature_not_supported exception must be thrown.
+  /// If this SYCL device does not support
+  /// info::partition_property::partition_equally a feature_not_supported
+  /// exception must be thrown.
   ///
-  /// \param ComputeUnits is a desired count of compute units in each sub device.
-  /// \return A vector class of sub devices partitioned from this SYCL device equally based on the ComputeUnits parameter.
+  /// \param ComputeUnits is a desired count of compute units in each sub
+  /// device. \return A vector class of sub devices partitioned from this SYCL
+  /// device equally based on the ComputeUnits parameter.
   template <info::partition_property prop>
   vector_class<device> create_sub_devices(size_t ComputeUnits) const;
 
   /// Partition device into sub devices
   ///
   /// Available only when prop is info::partition_property::partition_by_counts.
-  /// If this SYCL device does not support info::partition_property::partition_by_counts
-  /// a feature_not_supported exception must be thrown.
+  /// If this SYCL device does not support
+  /// info::partition_property::partition_by_counts a feature_not_supported
+  /// exception must be thrown.
   ///
   /// \param Counts is a vector_class of desired compute units in sub devices.
-  /// \return a vector_class of sub devices partitioned from this SYCL device by count sizes based on the Counts parameter.
+  /// \return a vector_class of sub devices partitioned from this SYCL device by
+  /// count sizes based on the Counts parameter.
   template <info::partition_property prop>
   vector_class<device>
   create_sub_devices(const vector_class<size_t> &Counts) const;
 
   /// Partition device into sub devices
   ///
-  /// Available only when prop is info::partition_property::partition_by_affinity_domain.
-  /// If this SYCL device does not support info::partition_property::partition_by_affinity_domain
-  /// or the SYCL device does not support info::affinity_domain provided
-  /// a feature_not_supported exception must be thrown.
+  /// Available only when prop is
+  /// info::partition_property::partition_by_affinity_domain. If this SYCL
+  /// device does not support
+  /// info::partition_property::partition_by_affinity_domain or the SYCL device
+  /// does not support info::affinity_domain provided a feature_not_supported
+  /// exception must be thrown.
   ///
-  /// \param AffinityDomain is one of the values described in Table 4.20 of SYCL Spec
-  /// \return a vector class of sub devices partitioned from this SYCL device by affinity domain based on the AffinityDomain parameter
+  /// \param AffinityDomain is one of the values described in Table 4.20 of SYCL
+  /// Spec \return a vector class of sub devices partitioned from this SYCL
+  /// device by affinity domain based on the AffinityDomain parameter
   template <info::partition_property prop>
   vector_class<device>
   create_sub_devices(info::partition_affinity_domain AffinityDomain) const;
 
-  /// Queries this SYCL device for information requested by the template parameter param
+  /// Queries this SYCL device for information requested by the template
+  /// parameter param
   ///
-  /// Specializations of info::param_traits must be defined in accordance with the info
-  /// parameters in Table 4.20 of SYCL Spec to facilitate returning the type
-  /// associated with the param parameter.
+  /// Specializations of info::param_traits must be defined in accordance with
+  /// the info parameters in Table 4.20 of SYCL Spec to facilitate returning the
+  /// type associated with the param parameter.
   ///
   /// \return device info of type described in Table 4.20.
   template <info::device param>
@@ -136,7 +146,7 @@ class device {
 
   /// Check SYCL extension support by device
   ///
-  /// @extension_name is a name of queried extension.
+  /// \param extension_name is a name of queried extension.
   /// \return true if SYCL device supports the extension.
   bool has_extension(const string_class &extension_name) const;
 
@@ -145,8 +155,9 @@ class device {
   /// The returned vector_class must contain a single SYCL device
   /// that is a host device, permitted by the deviceType parameter
   ///
-  /// @deviceType is one of the values described in A.3 of SYCL Spec
-  /// \return a vector_class containing all SYCL devices available in the system of the device type specified
+  /// \param deviceType is one of the values described in A.3 of SYCL Spec
+  /// \return a vector_class containing all SYCL devices available in the system
+  /// of the device type specified
   static vector_class<device>
   get_devices(info::device_type deviceType = info::device_type::all);