From 14ff4e34f979679978b4268e7870f0dd22441dd4 Mon Sep 17 00:00:00 2001 From: Mark Harris <783069+harrism@users.noreply.github.com> Date: Tue, 7 Nov 2023 05:59:28 +0000 Subject: [PATCH] Fix docs --- include/rmm/cuda_device.hpp | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/include/rmm/cuda_device.hpp b/include/rmm/cuda_device.hpp index 4de7d48e3..50d2e2e1f 100644 --- a/include/rmm/cuda_device.hpp +++ b/include/rmm/cuda_device.hpp @@ -29,7 +29,7 @@ struct cuda_device_id { using value_type = int; ///< Integer type used for device identifier /** - * @brief Construct a `cuda_device_id` from the specified integer value + * @brief Construct a `cuda_device_id` from the specified integer value. * * @param dev_id The device's integer identifier */ @@ -42,10 +42,11 @@ struct cuda_device_id { value_type id_; /** - * @brief Equality comparison operator + * @brief Compare two `cuda_device_id`s for equality. * - * @param other The other `cuda_device_id` to compare to - * @return true if the two `cuda_device_id`s wrap the same integer value, false otherwise + * @param lhs The first `cuda_device_id` to compare. + * @param rhs The second `cuda_device_id` to compare. + * @return true if the two `cuda_device_id`s wrap the same integer value, false otherwise. */ [[nodiscard]] friend constexpr bool operator==(cuda_device_id const& lhs, cuda_device_id const& rhs) noexcept @@ -54,10 +55,11 @@ struct cuda_device_id { } /** - * @brief Inequality comparison operator + * @brief Compare two `cuda_device_id`s for inequality. * - * @param other The other `cuda_device_id` to compare to - * @return true if the two `cuda_device_id`s wrap different integer values, false otherwise + * @param lhs The first `cuda_device_id` to compare. + * @param rhs The second `cuda_device_id` to compare. + * @return true if the two `cuda_device_id`s wrap different integer values, false otherwise. */ [[nodiscard]] friend constexpr bool operator!=(cuda_device_id const& lhs, cuda_device_id const& rhs) noexcept