Skip to content

Commit 34dfadf

Browse files
fixed grammar, added note that allocation return nullptr on failure
1 parent 7007eb9 commit 34dfadf

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

backends/include/dppl_sycl_usm_interface.h

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,77 +34,80 @@
3434
DPPL_C_EXTERN_C_BEGIN
3535

3636
/*!
37-
* @brief Crete USM shared memory.
37+
* @brief Create USM shared memory.
3838
*
3939
* @param size Number of bytes to allocate
4040
* @param QRef Sycl queue reference to use in allocation
4141
*
42-
* @return The pointer to USM shared memory.
42+
* @return The pointer to USM shared memory. On failure, returns nullptr.
4343
*/
4444
DPPL_API
4545
__dppl_give DPPLSyclUSMRef
4646
DPPLmalloc_shared (size_t size, __dppl_keep const DPPLSyclQueueRef QRef);
4747

4848
/*!
49-
* @brief Crete USM shared memory.
49+
* @brief Create USM shared memory.
5050
*
5151
* @param alignment Allocation's byte alignment
5252
* @param size Number of bytes to allocate
5353
* @param QRef Sycl queue reference to use in allocation
5454
*
5555
* @return The pointer to USM shared memory with the requested alignment.
56+
* On failure, returns nullptr.
5657
*/
5758
DPPL_API
5859
__dppl_give DPPLSyclUSMRef
5960
DPPLaligned_alloc_shared (size_t alignment, size_t size,
6061
__dppl_keep const DPPLSyclQueueRef QRef);
6162

6263
/*!
63-
* @brief Crete USM host memory.
64+
* @brief Create USM host memory.
6465
*
6566
* @param size Number of bytes to allocate
6667
* @param QRef Sycl queue reference to use in allocation
6768
*
68-
* @return The pointer to USM host memory.
69+
* @return The pointer to USM host memory. On failure, returns nullptr.
6970
*/
7071
DPPL_API
7172
__dppl_give DPPLSyclUSMRef
7273
DPPLmalloc_host (size_t size, __dppl_keep const DPPLSyclQueueRef QRef);
7374

7475
/*!
75-
* @brief Crete USM host memory.
76+
* @brief Create USM host memory.
7677
*
7778
* @param alignment Allocation's byte alignment
7879
* @param size Number of bytes to allocate
7980
* @param QRef Sycl queue reference to use in allocation
8081
*
8182
* @return The pointer to USM host memory with the requested alignment.
83+
* On failure, returns nullptr.
8284
*/
8385
DPPL_API
8486
__dppl_give DPPLSyclUSMRef
8587
DPPLaligned_alloc_host (size_t alignment, size_t size,
8688
__dppl_keep const DPPLSyclQueueRef QRef);
8789

8890
/*!
89-
* @brief Crete USM device memory.
91+
* @brief Create USM device memory.
9092
*
9193
* @param size Number of bytes to allocate
9294
* @param QRef Sycl queue reference to use in allocation
9395
*
94-
* @return The pointer to USM device memory.
96+
* @return The pointer to USM device memory. On failure, returns nullptr.
9597
*/
9698
DPPL_API
9799
__dppl_give DPPLSyclUSMRef
98100
DPPLmalloc_device (size_t size, __dppl_keep const DPPLSyclQueueRef QRef);
99101

100102
/*!
101-
* @brief Crete USM device memory.
103+
* @brief Create USM device memory.
102104
*
103105
* @param alignment Allocation's byte alignment
104106
* @param size Number of bytes to allocate
105107
* @param QRef Sycl queue reference to use in allocation
106108
*
107109
* @return The pointer to USM device memory with requested alignment.
110+
* On failure, returns nullptr.
108111
*/
109112
DPPL_API
110113
__dppl_give DPPLSyclUSMRef

0 commit comments

Comments
 (0)