Skip to content

Commit d272bfe

Browse files
committed
[Docs] Fix functions left out of documentation.
1 parent 4d625e7 commit d272bfe

2 files changed

Lines changed: 16 additions & 10 deletions

File tree

‎include/af/array.h‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ namespace af
330330
331331
\endcode
332332
333-
\note If \p src is \ref afHost, the first \p dim0 elements are copied. If \p src is \ref afDevice, no copy is done; the array object just wraps the device pointer.
333+
\note If \p src is \ref afHost, the first \p dim0 elements are copied. If \p src is \ref afDevice, no copy is done; the array object wraps the device pointer AND takes ownership ownership of the underlying memory.
334334
335335
*/
336336
template<typename T>
@@ -354,7 +354,7 @@ namespace af
354354
355355
\image html 2dArray.png
356356
357-
\note If \p src is \ref afHost, the first \p dim0 * \p dim1 elements are copied. If \p src is \ref afDevice, no copy is done; the array object just wraps the device pointer. The data is treated as column major format when performing linear algebra operations.
357+
\note If \p src is \ref afHost, the first \p dim0 * \p dim1 elements are copied. If \p src is \ref afDevice, no copy is done; the array object wraps the device pointer AND takes ownership ownership of the underlying memory. The data is treated as column major format when performing linear algebra operations.
358358
*/
359359
template<typename T>
360360
array(dim_t dim0, dim_t dim1,
@@ -378,7 +378,7 @@ namespace af
378378
array A(3, 3, 2, h_buffer); // copy host data to 3D device array
379379
\endcode
380380
381-
\note If \p src is \ref afHost, the first \p dim0 * \p dim1 * \p dim2 elements are copied. If \p src is \ref afDevice, no copy is done; the array object just wraps the device pointer. The data is treated as column major format when performing linear algebra operations.
381+
\note If \p src is \ref afHost, the first \p dim0 * \p dim1 * \p dim2 elements are copied. If \p src is \ref afDevice, no copy is done; the array object just wraps the device pointer and does not take ownership of the underlying memory. The data is treated as column major format when performing linear algebra operations.
382382
383383
\image html 3dArray.png
384384
*/
@@ -407,7 +407,7 @@ namespace af
407407
array A(2, 2, 2, 2, h_buffer); // copy host data to 4D device array
408408
\endcode
409409
410-
\note If \p src is \ref afHost, the first \p dim0 * \p dim1 * \p dim2 * \p dim3 elements are copied. If \p src is \ref afDevice, no copy is done; the array object just wraps the device pointer. The data is treated as column major format when performing linear algebra operations.
410+
\note If \p src is \ref afHost, the first \p dim0 * \p dim1 * \p dim2 * \p dim3 elements are copied. If \p src is \ref afDevice, no copy is done; the array object just wraps the device pointer and does not take ownership of the underlying memory. The data is treated as column major format when performing linear algebra operations.
411411
*/
412412
template<typename T>
413413
array(dim_t dim0, dim_t dim1, dim_t dim2, dim_t dim3,
@@ -444,7 +444,7 @@ namespace af
444444
// used in ArrayFire
445445
\endcode
446446
447-
\note If \p src is \ref afHost, the first dims.elements() elements are copied. If \p src is \ref afDevice, no copy is done; the array object just wraps the device pointer. The data is treated as column major format when performing linear algebra operations.
447+
\note If \p src is \ref afHost, the first dims.elements() elements are copied. If \p src is \ref afDevice, no copy is done; the array object just wraps the device pointer and does not take ownership of the underlying memory. The data is treated as column major format when performing linear algebra operations.
448448
*/
449449
template<typename T>
450450
explicit

‎include/af/opencl.h‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -163,13 +163,11 @@ AFAPI af_err afcl_get_platform(afcl_platform *res);
163163
namespace afcl
164164
{
165165

166-
/**
167-
168-
*/
169166
/**
170-
\ingroup opencl_mat
167+
\addtogroup opencl_mat
171168
@{
172169
*/
170+
173171
/**
174172
Get a handle to ArrayFire's OpenCL context
175173
@@ -304,7 +302,7 @@ static inline deviceType getDeviceType()
304302

305303
#if AF_API_VERSION >= 33
306304
/**
307-
Get the type of the current device
305+
Get the type of the current platform
308306
*/
309307
static inline platform getPlatform()
310308
{
@@ -438,6 +436,10 @@ static inline platform getPlatform()
438436

439437
namespace af
440438
{
439+
/**
440+
\addtogroup opencl_mat
441+
@{
442+
*/
441443

442444
#if !defined(AF_OPENCL)
443445
template<> AFAPI cl_mem *array::device() const
@@ -449,6 +451,10 @@ template<> AFAPI cl_mem *array::device() const
449451
}
450452
#endif
451453

454+
/**
455+
@}
456+
*/
457+
452458
}
453459

454460
#endif

0 commit comments

Comments
 (0)