Skip to content

Commit 96b760a

Browse files
author
Diptorup Deb
committed
Few more tweaks.
1 parent 709bf20 commit 96b760a

File tree

5 files changed

+9
-18
lines changed

5 files changed

+9
-18
lines changed

docs/Doxyfile.in

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -917,7 +917,11 @@ RECURSIVE = YES
917917
# Note that relative paths are relative to the directory from which doxygen is
918918
# run.
919919

920-
EXCLUDE =
920+
EXCLUDE = ../dpctl-capi/include/Support
921+
EXCLUDE += ../dpctl-capi/include/Config
922+
EXCLUDE += ../dpctl-capi/include/dpctl_vector.h
923+
EXCLUDE += ../dpctl-capi/include/dpctl_data_types.h
924+
EXCLUDE += ../dpctl-capi/include/dpctl_utils.h
921925

922926
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
923927
# directories that are symbolic links (a Unix file system feature) are excluded
@@ -933,7 +937,7 @@ EXCLUDE_SYMLINKS = NO
933937
# Note that the wildcards are matched against the file with absolute path, so to
934938
# exclude all test directories for example use the pattern */test/*
935939

936-
EXCLUDE_PATTERNS =
940+
EXCLUDE_PATTERNS =
937941

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

docs/doxyrest-config.lua.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,14 +257,14 @@ PROTECTION_FILTER = "public"
257257
--! setting to ``false``.
258258
--!
259259

260-
EXCLUDE_EMPTY_DEFINES = false
260+
EXCLUDE_EMPTY_DEFINES = true
261261

262262
--!
263263
--! If non-``nil``, each define will be checked using this regular expression
264264
--! and if its name matches, this define will be excluded from the documentation.
265265
--!
266266

267-
EXCLUDE_DEFINE_PATTERN = nil
267+
EXCLUDE_DEFINE_PATTERN = "DPCTL_API"
268268

269269
--!
270270
--! Usually providing documentation blocks for default constructors is

dpctl-capi/include/Support/MemOwnershipAttrs.h

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,6 @@
2828

2929
#pragma once
3030

31-
/**
32-
* @defgroup PtrOwnershipAttr Memory management attributes.
33-
* This file defines a group of macros that serve as attributes indicating the
34-
* type of ownership of a pointer. The macros are modeled after similar
35-
* attributes defined in Integer Set Library (isl) and serve the purpose of
36-
* helping a programmer understand the semantics of a dpctl function.
37-
*/
38-
3931
/**
4032
* @def __dpctl_give
4133
* @brief The __dpctl_give attribute indicates that a new object is returned and
@@ -46,7 +38,6 @@
4638
* free the object, he/she should make sure to use it exactly once as a value
4739
* for a __dpctl_take argument. However, the user is free to use the object as
4840
* he/she likes as a value to __dpctl_keep arguments.
49-
* @ingroup PtrOwnershipAttr
5041
*/
5142
#ifndef __dpctl_give
5243
#define __dpctl_give
@@ -62,7 +53,6 @@
6253
* function. If the pointer annotated with __dpctl_take is NULL then it is
6354
* treated as an error, since it may prevent the normal behavior of the
6455
* function.
65-
* @ingroup PtrOwnershipAttr
6656
*/
6757
#ifndef __dpctl_take
6858
#define __dpctl_take
@@ -72,14 +62,12 @@
7262
* @def __dpctl_keep
7363
* @brief The __dpctl_keep attribute indicates that the function only uses the
7464
* object and does not destroy it before returning.
75-
* @ingroup PtrOwnershipAttr
7665
*/
7766
#define __dpctl_keep
7867
#endif
7968
/*!
8069
* @def __dpctl_null
8170
* @brief The __dpctl_null attribute indicates that a NULL value is returned.
82-
* @ingroup PtrOwnershipAttr
8371
*/
8472
#ifndef __dpctl_null
8573
#define __dpctl_null

dpctl-capi/include/dpctl_sycl_device_selector_interface.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ __dpctl_give DPCTLSyclDeviceSelectorRef DPCTLAcceleratorSelector_Create();
5050
* @brief Returns an opaque wrapper for sycl::default_selector object.
5151
*
5252
* @return An opaque pointer to a sycl::default_selector object.
53+
* @ingroup DeviceSelectors
5354
*/
5455
DPCTL_API
5556
__dpctl_give DPCTLSyclDeviceSelectorRef DPCTLDefaultSelector_Create();

dpctl-capi/include/dpctl_sycl_types.h

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,12 @@ typedef struct DPCTLOpaqueSyclProgram *DPCTLSyclProgramRef;
7474
/*!
7575
* @brief Opaque pointer to a sycl::queue
7676
*
77-
* @see sycl::queue
7877
*/
7978
typedef struct DPCTLOpaqueSyclQueue *DPCTLSyclQueueRef;
8079

8180
/*!
8281
* @brief Used to pass a sycl::usm memory opaquely through DPCTL interfaces.
8382
*
84-
* @see sycl::usm
8583
*/
8684
typedef struct DPCTLOpaqueSyclUSM *DPCTLSyclUSMRef;
8785

0 commit comments

Comments
 (0)