Add documentation for alignment params

rapidsai · Jan 9, 2024 · ce58ff5 · ce58ff5
1 parent 4ef844a
commit ce58ff5
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/include/rmm/mr/pinned_host_memory_resource.hpp b/include/rmm/mr/pinned_host_memory_resource.hpp
@@ -52,6 +52,8 @@ class pinned_host_memory_resource {
    * reason.
    *
    * @param bytes The size, in bytes, of the allocation.
+   * @param alignment Alignment in bytes. Default alignment is used if unspecified.
+   *
    * @return Pointer to the newly allocated memory.
    */
   static void* allocate(
@@ -72,6 +74,7 @@ class pinned_host_memory_resource {
    *
    * @param ptr Pointer to be deallocated.
    * @param bytes Size of the allocation.
+   * @param alignment Alignment in bytes. Default alignment is used if unspecified.
    */
   static void deallocate(
     void* ptr,