Skip to content

Commit 0e22fdd

Browse files
authored
[SYCL] Fix some Doxygen build warnings (#4170)
This is done as a part of #4140 * Changed several parameter types to parameter argument names (under \param tag) * Renamed parameter names as they were changes in code, but not in documentation comment
1 parent 7981e60 commit 0e22fdd

File tree

6 files changed

+21
-18
lines changed

6 files changed

+21
-18
lines changed

sycl/include/CL/sycl/context.hpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ class __SYCL_EXPORT context {
106106
/// PropList.
107107
///
108108
/// \param Platform is an instance of SYCL platform.
109+
/// \param AsyncHandler is an instance of async_handler.
109110
/// \param PropList is an instance of property_list.
110111
explicit context(const platform &Platform, async_handler AsyncHandler,
111112
const property_list &PropList = {});

sycl/include/CL/sycl/detail/pi.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1147,7 +1147,7 @@ __SYCL_EXPORT pi_result piclProgramCreateWithSource(pi_context context,
11471147
/// succesfully or not, for each device in device_list.
11481148
/// binary_status is ignored if it is null and otherwise
11491149
/// it must be an array of num_devices elements.
1150-
/// \param program is the PI program created from the program binaries.
1150+
/// \param ret_program is the PI program created from the program binaries.
11511151
__SYCL_EXPORT pi_result piProgramCreateWithBinary(
11521152
pi_context context, pi_uint32 num_devices, const pi_device *device_list,
11531153
const size_t *lengths, const unsigned char **binaries,
@@ -1565,8 +1565,8 @@ using pi_usm_migration_flags = _pi_usm_migration_flags;
15651565
///
15661566
/// \param result_ptr contains the allocated memory
15671567
/// \param context is the pi_context
1568-
/// \param pi_usm_mem_properties are optional allocation properties
1569-
/// \param size_t is the size of the allocation
1568+
/// \param properties are optional allocation properties
1569+
/// \param size is the size of the allocation
15701570
/// \param alignment is the desired alignment of the allocation
15711571
__SYCL_EXPORT pi_result piextUSMHostAlloc(void **result_ptr, pi_context context,
15721572
pi_usm_mem_properties *properties,
@@ -1577,8 +1577,8 @@ __SYCL_EXPORT pi_result piextUSMHostAlloc(void **result_ptr, pi_context context,
15771577
/// \param result_ptr contains the allocated memory
15781578
/// \param context is the pi_context
15791579
/// \param device is the device the memory will be allocated on
1580-
/// \param pi_usm_mem_properties are optional allocation properties
1581-
/// \param size_t is the size of the allocation
1580+
/// \param properties are optional allocation properties
1581+
/// \param size is the size of the allocation
15821582
/// \param alignment is the desired alignment of the allocation
15831583
__SYCL_EXPORT pi_result piextUSMDeviceAlloc(void **result_ptr,
15841584
pi_context context,
@@ -1591,8 +1591,8 @@ __SYCL_EXPORT pi_result piextUSMDeviceAlloc(void **result_ptr,
15911591
/// \param result_ptr contains the allocated memory
15921592
/// \param context is the pi_context
15931593
/// \param device is the device the memory will be allocated on
1594-
/// \param pi_usm_mem_properties are optional allocation properties
1595-
/// \param size_t is the size of the allocation
1594+
/// \param properties are optional allocation properties
1595+
/// \param size is the size of the allocation
15961596
/// \param alignment is the desired alignment of the allocation
15971597
__SYCL_EXPORT pi_result piextUSMSharedAlloc(void **result_ptr,
15981598
pi_context context,
@@ -1682,7 +1682,7 @@ __SYCL_EXPORT pi_result piextUSMEnqueueMemAdvise(pi_queue queue,
16821682
/// \param param_name is the type of query to perform
16831683
/// \param param_value_size is the size of the result in bytes
16841684
/// \param param_value is the result
1685-
/// \param param_value_ret is how many bytes were written
1685+
/// \param param_value_size_ret is how many bytes were written
16861686
__SYCL_EXPORT pi_result piextUSMGetMemAllocInfo(
16871687
pi_context context, const void *ptr, pi_mem_info param_name,
16881688
size_t param_value_size, void *param_value, size_t *param_value_size_ret);

sycl/plugins/cuda/pi_cuda.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4654,7 +4654,7 @@ pi_result cuda_piextUSMEnqueueMemAdvise(pi_queue queue, const void *ptr,
46544654
/// \param param_name is the type of query to perform
46554655
/// \param param_value_size is the size of the result in bytes
46564656
/// \param param_value is the result
4657-
/// \param param_value_ret is how many bytes were written
4657+
/// \param param_value_size_ret is how many bytes were written
46584658
pi_result cuda_piextUSMGetMemAllocInfo(pi_context context, const void *ptr,
46594659
pi_mem_info param_name,
46604660
size_t param_value_size,

sycl/source/detail/program_impl.hpp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ class program_impl {
4545
/// with the context.
4646
///
4747
/// \param Context is a pointer to SYCL context impl.
48+
/// \param PropList is an instance of property_list.
4849
explicit program_impl(ContextImplPtr Context, const property_list &PropList);
4950

5051
/// Constructs an instance of SYCL program for the provided DeviceList.
@@ -55,6 +56,7 @@ class program_impl {
5556
///
5657
/// \param Context is a pointer to SYCL context impl.
5758
/// \param DeviceList is a list of SYCL devices.
59+
/// \param PropList is an instance of property_list.
5860
program_impl(ContextImplPtr Context, std::vector<device> DeviceList,
5961
const property_list &PropList);
6062

@@ -72,6 +74,7 @@ class program_impl {
7274
///
7375
/// \param ProgramList is a list of program_impl instances.
7476
/// \param LinkOptions is a string containing valid OpenCL link options.
77+
/// \param PropList is an instance of property_list.
7578
program_impl(std::vector<std::shared_ptr<program_impl>> ProgramList,
7679
std::string LinkOptions, const property_list &PropList);
7780

sycl/source/detail/scheduler/scheduler.hpp

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -432,14 +432,14 @@ class Scheduler {
432432

433433
/// Allocate buffers in the pool for a provided stream
434434
///
435-
/// \param Pointer to the stream object
436-
/// \param Size of the stream buffer
437-
/// \param Size of the flush buffer for a single work item
435+
/// \param Impl to the stream object
436+
/// \param StreamBufferSize of the stream buffer
437+
/// \param FlushBufferSize of the flush buffer for a single work item
438438
void allocateStreamBuffers(stream_impl *, size_t, size_t);
439439

440440
/// Deallocate all stream buffers in the pool
441441
///
442-
/// \param Pointer to the stream object
442+
/// \param Impl to the stream object
443443
void deallocateStreamBuffers(stream_impl *);
444444

445445
QueueImplPtr getDefaultHostQueue() { return DefaultHostQueue; }
@@ -737,7 +737,6 @@ class Scheduler {
737737
/// Enqueues the command and all its dependencies.
738738
///
739739
/// \param EnqueueResult is set to specific status if enqueue failed.
740-
/// \param GraphReadLock read-lock which is already acquired for reading
741740
/// \return true if the command is successfully enqueued.
742741
///
743742
/// The function may unlock and lock GraphReadLock as needed. Upon return

sycl/source/detail/usm/usm_impl.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -325,8 +325,8 @@ void *aligned_alloc(size_t Alignment, size_t Size, const queue &Q, alloc Kind,
325325
/// Query the allocation type from a USM pointer
326326
/// Returns alloc::host for all pointers in a host context.
327327
///
328-
/// \param ptr is the USM pointer to query
329-
/// \param ctxt is the sycl context the ptr was allocated in
328+
/// \param Ptr is the USM pointer to query
329+
/// \param Ctxt is the sycl context the ptr was allocated in
330330
alloc get_pointer_type(const void *Ptr, const context &Ctxt) {
331331
if (!Ptr)
332332
return alloc::unknown;
@@ -375,8 +375,8 @@ alloc get_pointer_type(const void *Ptr, const context &Ctxt) {
375375

376376
/// Queries the device against which the pointer was allocated
377377
///
378-
/// \param ptr is the USM pointer to query
379-
/// \param ctxt is the sycl context the ptr was allocated in
378+
/// \param Ptr is the USM pointer to query
379+
/// \param Ctxt is the sycl context the ptr was allocated in
380380
device get_pointer_device(const void *Ptr, const context &Ctxt) {
381381
// Check if ptr is a valid USM pointer
382382
if (get_pointer_type(Ptr, Ctxt) == alloc::unknown)

0 commit comments

Comments
 (0)