Skip to content

Commit 871e46f

Browse files
author
Diptorup Deb
committed
Minor fixes...
1 parent 00ecd34 commit 871e46f

14 files changed

+57
-43
lines changed

‎docs/Doxyfile.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -937,7 +937,7 @@ EXCLUDE_SYMLINKS = NO
937937
# Note that the wildcards are matched against the file with absolute path, so to
938938
# exclude all test directories for example use the pattern */test/*
939939

940-
EXCLUDE_PATTERNS =
940+
EXCLUDE_PATTERNS =
941941

942942
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
943943
# (namespaces, classes, functions, etc.) that should be excluded from the

‎dpctl-capi/include/dpctl_sycl_context_interface.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
DPCTL_C_EXTERN_C_BEGIN
3939

4040
/**
41-
* @defgroup ContextInterface Context Interface
41+
* @defgroup ContextInterface Context class C wrapper
4242
*/
4343

4444
/*!
@@ -113,6 +113,7 @@ DPCTLContext_Copy(__dpctl_keep const DPCTLSyclContextRef CRef);
113113
*
114114
* @param CRef DPCTLSyclContexRef object to query.
115115
* @return A positive count on success or zero on error.
116+
* @ingroup ContextInterface
116117
*/
117118
DPCTL_API
118119
size_t DPCTLContext_DeviceCount(__dpctl_keep const DPCTLSyclContextRef CRef);
@@ -123,6 +124,7 @@ size_t DPCTLContext_DeviceCount(__dpctl_keep const DPCTLSyclContextRef CRef);
123124
*
124125
* @param CRef DPCTLSyclContexRef object to query.
125126
* @return A DPCTLDeviceVectorRef with devices associated with given CRef.
127+
* @ingroup ContextInterface
126128
*/
127129
DPCTL_API
128130
__dpctl_give DPCTLDeviceVectorRef

‎dpctl-capi/include/dpctl_sycl_device_interface.h

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
DPCTL_C_EXTERN_C_BEGIN
3939

4040
/**
41-
* @defgroup DeviceInterface Device Interface
41+
* @defgroup DeviceInterface Device class C wrapper
4242
*/
4343

4444
/*!
@@ -304,6 +304,7 @@ bool DPCTLDevice_HasAspect(__dpctl_keep const DPCTLSyclDeviceRef DRef,
304304
* @param count Count compute units that need to contains in
305305
* subdevices
306306
* @return A #DPCTLDeviceVectorRef containing #DPCTLSyclDeviceRef objects
307+
* @ingroup DeviceInterface
307308
*/
308309
DPCTL_API
309310
__dpctl_give DPCTLDeviceVectorRef
@@ -321,6 +322,7 @@ DPCTLDevice_CreateSubDevicesEqually(__dpctl_keep const DPCTLSyclDeviceRef DRef,
321322
* that need to contains in subdevices
322323
* @param ncounts Number of counts
323324
* @return A #DPCTLDeviceVectorRef containing #DPCTLSyclDeviceRef objects
325+
* @ingroup DeviceInterface
324326
*/
325327
DPCTL_API
326328
__dpctl_give DPCTLDeviceVectorRef
@@ -329,14 +331,16 @@ DPCTLDevice_CreateSubDevicesByCounts(__dpctl_keep const DPCTLSyclDeviceRef DRef,
329331
size_t ncounts);
330332

331333
/*!
332-
* @brief Returns a vector of sub devices
334+
* @brief Returns a vector of sub-devices
333335
* partitioned from this SYCL device by affinity domain based on the domain
334336
* parameter.
335337
*
336-
* @param DRef Opaque pointer to a sycl::device
337-
* @param DPCTLPartitionAffinityDomainType DPCTLPartitionAffinityDomainType
338-
* of sycl::info::partition_affinity_domain
338+
* @param DRef Opaque pointer to a ``sycl::device``
339+
* @param DPCTLPartitionAffinityDomainType PartitionAffinityDomainTy
340+
* of ``sycl::info::partition_affinity_domain``
341+
*
339342
* @return A #DPCTLDeviceVectorRef containing #DPCTLSyclDeviceRef objects
343+
* @ingroup DeviceInterface
340344
*/
341345
DPCTL_API
342346
__dpctl_give DPCTLDeviceVectorRef DPCTLDevice_CreateSubDevicesByAffinity(
@@ -349,7 +353,7 @@ DPCTL_C_EXTERN_C_END
349353
* @brief Wrapper over
350354
* device.get_info<info::device::sub_group_independent_forward_progress>.
351355
*
352-
* @param DRef Opaque pointer to a sycl::device
356+
* @param DRef Opaque pointer to a ``sycl::device``
353357
* @return Returns true if the device supports independent forward progress of
354358
* sub-groups with respect to other sub-groups in the same work-group.
355359
* @ingroup DeviceInterface

‎dpctl-capi/include/dpctl_sycl_device_manager.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535

3636
DPCTL_C_EXTERN_C_BEGIN
3737

38-
/*! \addtogroup DeviceManager Device Manager
38+
/*! \addtogroup DeviceManager Device class helper functions
3939
* Helper functions for sycl::device objects that do not directly map to any
4040
* sycl::device member function.
4141
* @{

‎dpctl-capi/include/dpctl_sycl_device_selector_interface.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
DPCTL_C_EXTERN_C_BEGIN
3535

3636
/**
37-
* @defgroup DeviceSelectors Device Selector Interface
37+
* @defgroup DeviceSelectors Device selection
3838
*/
3939

4040
/*!

‎dpctl-capi/include/dpctl_sycl_enum_types.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ enum DPCTLSyclAspectType
123123
};
124124

125125
/*!
126-
* @brief DPCTL analogue of sycl::info::partition_affinity_domain enum
126+
* @brief DPCTL analogue of ``sycl::info::partition_affinity_domain`` enum.
127127
*
128128
*/
129129
enum DPCTLPartitionAffinityDomainType

‎dpctl-capi/include/dpctl_sycl_event_interface.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
DPCTL_C_EXTERN_C_BEGIN
3535

3636
/**
37-
* @defgroup EventInterface Event Interface
37+
* @defgroup EventInterface Event class C wrapper
3838
*/
3939

4040
/*!

‎dpctl-capi/include/dpctl_sycl_kernel_interface.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
DPCTL_C_EXTERN_C_BEGIN
3636

3737
/**
38-
* @defgroup KernelInterface Kernel Interface
38+
* @defgroup KernelInterface Kernel class C wrapper
3939
*/
4040

4141
/*!

‎dpctl-capi/include/dpctl_sycl_platform_interface.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
DPCTL_C_EXTERN_C_BEGIN
3737

3838
/**
39-
* @defgroup PlatformInterface Platform Interface
39+
* @defgroup PlatformInterface Platform class C wrapper
4040
*/
4141

4242
/*!

‎dpctl-capi/include/dpctl_sycl_platform_manager.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@
3333

3434
DPCTL_C_EXTERN_C_BEGIN
3535

36-
/*! \addtogroup PlatformManager Platform Manager
37-
* Helper functions for sycl::platform objects that do not directly map to any
38-
* sycl::platform member function.
36+
/*! \addtogroup PlatformManager Platform class helper functions
37+
* Helper functions for ``sycl::platform`` objects that do not directly map to
38+
* any ``sycl::platform`` member function.
3939
* @{
4040
*/
4141

‎dpctl-capi/include/dpctl_sycl_program_interface.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
DPCTL_C_EXTERN_C_BEGIN
3636

3737
/**
38-
* @defgroup ProgramInterface Program Interface
38+
* @defgroup ProgramInterface Program class C wrapper
3939
*/
4040

4141
/*!

‎dpctl-capi/include/dpctl_sycl_queue_interface.h

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
DPCTL_C_EXTERN_C_BEGIN
3939

4040
/**
41-
* @defgroup QueueInterface Queue Interface
41+
* @defgroup QueueInterface Queue class C wrapper
4242
*/
4343

4444
/*!
@@ -66,28 +66,36 @@ DPCTLQueue_Create(__dpctl_keep const DPCTLSyclContextRef CRef,
6666
int properties);
6767

6868
/*!
69-
* @brief Constructs a sycl::queue object of the specified SYCL device.
69+
* @brief Constructs a ``sycl::queue`` object of the specified SYCL device.
7070
*
71-
* Constructs a new SYCL queue for the specified SYCL device. The behaviour of
72-
* this function differs from the SYCL `queue(const device &syclDevice, const
73-
* async_handler &asyncHandler, const property_list &propList = {})` constructor
74-
* of the queue class. Unlike the SYCL queue class constructor, we try not to
75-
* create a new SYCL context for the device and instead look to reuse a
76-
* previously cached SYCL context for the device (refer
77-
* dpctl_sycl_device_manager.cpp). DPCTL caches contexts only for root devices
78-
* and for all custom devices the function begaves the same way as the SYCL
79-
* constructor.
71+
* Constructs a new SYCL queue for the specified SYCL device. The
72+
* behaviour of this function differs from the following queue constructor:
8073
*
81-
* @param dRef An opaque pointer to a sycl::device.
74+
* @code
75+
* queue(
76+
* const device &syclDevice,
77+
* const async_handler &asyncHandler,
78+
* const property_list &propList = {}
79+
* )
80+
* @endcode
81+
*
82+
* Unlike the SYCL queue constructor, we try not to create a new SYCL
83+
* context for the device and instead look to reuse a previously cached
84+
* SYCL context for the device (refer dpctl_sycl_device_manager.cpp).
85+
* DPCTL caches contexts only for root devices and for all custom devices the
86+
* function begaves the same way as the SYCL constructor.
87+
*
88+
* @param dRef An opaque pointer to a ``sycl::device``.
8289
* @param error_handler A callback function that will be invoked by the
8390
* async_handler used during queue creation. Can be
8491
* NULL if no async_handler is needed.
8592
* @param properties A combination of bit flags using the values defined
8693
* in the DPCTLQueuePropertyType enum. The bit flags
87-
* are used to create a sycl::property_list that is
94+
* are used to create a ``sycl::property_list`` that is
8895
* passed to the SYCL queue constructor.
89-
* @return An opaque DPCTLSyclQueueRef pointer containing the new sycl::queue
90-
* object. A nullptr is returned if the queue could not be created.
96+
* @return An opaque DPCTLSyclQueueRef pointer containing the new
97+
* ``sycl::queue`` object. A nullptr is returned if the queue could not be
98+
* created.
9199
* @ingroup QueueInterface
92100
*/
93101
DPCTL_API

‎dpctl-capi/include/dpctl_sycl_queue_manager.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
DPCTL_C_EXTERN_C_BEGIN
3636

3737
/**
38-
* @defgroup QueueManager Queue Manager
38+
* @defgroup QueueManager Queue class helper functions
3939
*/
4040

4141
/*!

‎dpctl-capi/include/dpctl_sycl_types.h

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,55 +30,55 @@
3030
DPCTL_C_EXTERN_C_BEGIN
3131

3232
/*!
33-
* @brief Opaque pointer to a sycl::context
33+
* @brief Opaque pointer to a ``sycl::context``
3434
*
3535
*/
3636
typedef struct DPCTLOpaqueSyclContext *DPCTLSyclContextRef;
3737

3838
/*!
39-
* @brief Opaque pointer to a sycl::device
39+
* @brief Opaque pointer to a ``sycl::device``
4040
*
4141
*/
4242
typedef struct DPCTLOpaqueSyclDevice *DPCTLSyclDeviceRef;
4343

4444
/*!
45-
* @brief Opaque pointer to a sycl::device_selector
45+
* @brief Opaque pointer to a ``sycl::device_selector``
4646
*
4747
*/
4848
typedef struct DPCTLOpaqueSyclDeviceSelector *DPCTLSyclDeviceSelectorRef;
4949

5050
/*!
51-
* @brief Opaque pointer to a sycl::event
51+
* @brief Opaque pointer to a ``sycl::event``
5252
*
5353
*/
5454
typedef struct DPCTLOpaqueSyclEvent *DPCTLSyclEventRef;
5555

5656
/*!
57-
* @brief Opaque pointer to a sycl::kernel
57+
* @brief Opaque pointer to a ``sycl::kernel``
5858
*
5959
*/
6060
typedef struct DPCTLOpaqueSyclKernel *DPCTLSyclKernelRef;
6161

6262
/*!
63-
* @brief Opaque pointer to a sycl::platform
63+
* @brief Opaque pointer to a ``sycl::platform``
6464
*
6565
*/
6666
typedef struct DPCTLOpaqueSyclPlatform *DPCTLSyclPlatformRef;
6767

6868
/*!
69-
* @brief Opaque pointer to a sycl::program
69+
* @brief Opaque pointer to a ``sycl::program``
7070
*
7171
*/
7272
typedef struct DPCTLOpaqueSyclProgram *DPCTLSyclProgramRef;
7373

7474
/*!
75-
* @brief Opaque pointer to a sycl::queue
75+
* @brief Opaque pointer to a ``sycl::queue``
7676
*
7777
*/
7878
typedef struct DPCTLOpaqueSyclQueue *DPCTLSyclQueueRef;
7979

8080
/*!
81-
* @brief Used to pass a sycl::usm memory opaquely through DPCTL interfaces.
81+
* @brief Used to pass a ``sycl::usm`` memory opaquely through DPCTL interfaces.
8282
*
8383
*/
8484
typedef struct DPCTLOpaqueSyclUSM *DPCTLSyclUSMRef;

0 commit comments

Comments
 (0)