Do not put rmm::bad_alloc in quotes

Also `Nothing` seems to be an invalid type
rapidsai · Nov 7, 2023 · e867442 · e867442
1 parent 17021f1
commit e867442
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 13 deletions.
diff --git a/include/rmm/mr/device/device_memory_resource.hpp b/include/rmm/mr/device/device_memory_resource.hpp
@@ -162,7 +162,7 @@ class device_memory_resource {
    *
    * The returned pointer will have at minimum 256 byte alignment.
    *
-   * @throws `rmm::bad_alloc` When the requested `bytes` cannot be allocated on
+   * @throws rmm::bad_alloc When the requested `bytes` cannot be allocated on
    * the specified `stream`.
    *
    * @param bytes The size of the allocation
@@ -182,8 +182,6 @@ class device_memory_resource {
    * it points to must not yet have been deallocated, otherwise behavior is
    * undefined.
    *
-   * @throws Nothing.
-   *
    * @param ptr Pointer to be deallocated
    * @param bytes The size in bytes of the allocation. This must be equal to the
    * value of `bytes` that was passed to the `allocate` call that returned `p`.
@@ -199,7 +197,7 @@ class device_memory_resource {
    *
    * The returned pointer will have at minimum 256 byte alignment.
    *
-   * @throws `rmm::bad_alloc` When the requested `bytes` cannot be allocated on
+   * @throws rmm::bad_alloc When the requested `bytes` cannot be allocated on
    * the specified `stream`.
    *
    * @param bytes The size of the allocation
@@ -217,7 +215,7 @@ class device_memory_resource {
    *
    * The returned pointer will have at minimum 256 byte alignment.
    *
-   * @throws `rmm::bad_alloc` When the requested `bytes` cannot be allocated on
+   * @throws rmm::bad_alloc When the requested `bytes` cannot be allocated on
    * the specified `stream`.
    *
    * @param bytes The size of the allocation
@@ -237,8 +235,6 @@ class device_memory_resource {
    * it points to must not yet have been deallocated, otherwise behavior is
    * undefined.
    *
-   * @throws Nothing.
-   *
    * @param ptr Pointer to be deallocated
    * @param bytes The size in bytes of the allocation. This must be equal to the
    * value of `bytes` that was passed to the `allocate` call that returned `p`.
@@ -261,8 +257,6 @@ class device_memory_resource {
    * it points to must not yet have been deallocated, otherwise behavior is
    * undefined.
    *
-   * @throws Nothing.
-   *
    * @param ptr Pointer to be deallocated
    * @param bytes The size in bytes of the allocation. This must be equal to the
    * value of `bytes` that was passed to the `allocate` call that returned `p`.

diff --git a/include/rmm/mr/host/pinned_memory_resource.hpp b/include/rmm/mr/host/pinned_memory_resource.hpp
@@ -78,7 +78,7 @@ class pinned_memory_resource final : public host_memory_resource {
   /**
    * @brief Pretent to support the allocate_async interface, falling back to stream 0
    *
-   * @throws `rmm::bad_alloc` When the requested `bytes` cannot be allocated on
+   * @throws rmm::bad_alloc When the requested `bytes` cannot be allocated on
    * the specified `stream`.
    *
    * @param bytes The size of the allocation
@@ -93,7 +93,7 @@ class pinned_memory_resource final : public host_memory_resource {
   /**
    * @brief Pretent to support the allocate_async interface, falling back to stream 0
    *
-   * @throws `rmm::bad_alloc` When the requested `bytes` cannot be allocated on
+   * @throws rmm::bad_alloc When the requested `bytes` cannot be allocated on
    * the specified `stream`.
    *
    * @param bytes The size of the allocation
@@ -107,8 +107,6 @@ class pinned_memory_resource final : public host_memory_resource {
   /**
    * @brief Pretent to support the deallocate_async interface, falling back to stream 0
    *
-   * @throws Nothing.
-   *
    * @param ptr Pointer to be deallocated
    * @param bytes The size in bytes of the allocation. This must be equal to the
    * value of `bytes` that was passed to the `allocate` call that returned `p`.