1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
From: Kari Pahula <kaol@debian.org>
Date: Fri, 28 Jun 2024 16:07:05 +0300
Subject: doxygen-refs
Summary: Use typedef names instead of struct names in references
Since Doxygen is using TYPEDEF_HIDES_STRUCTS = YES references should
be using the typedef names instead of struct names for references.
Doxygen fails with an error on these otherwise.
Marked as Forwarded: non-needed since upstream solved the issue by
introducing the struct names to Doxygen with a @struct instead of
using typedef names. It's not correct IMHO but I don't think it's
worth making a PR over it. Most likely the next release will have a
fix in some form anyway and this patch will be dropped.
Forwarded: not-needed
---
library/include/hipfft/hipfftXt.h | 18 +++++++++---------
library/include/hipfft/hiplibxt.h | 2 +-
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/library/include/hipfft/hipfftXt.h b/library/include/hipfft/hipfftXt.h
index 41dc671..ebcf0e0 100644
--- a/library/include/hipfft/hipfftXt.h
+++ b/library/include/hipfft/hipfftXt.h
@@ -279,7 +279,7 @@ typedef enum hipfftXtSubFormat_t
/*! @brief Allocate memory on multiple devices.
*
* Allocate memory on multiple devices for the specified plan.
- * Returns a \ref hipLibXtDesc_t descriptor which includes pointers
+ * Returns a \ref hipLibXtDesc descriptor which includes pointers
* to the allocated memory, devices that memory resides on, and
* sizes allocated.
*
@@ -298,13 +298,13 @@ HIPFFT_EXPORT hipfftResult hipfftXtMalloc(hipfftHandle plan,
hipLibXtDesc** desc,
hipfftXtSubFormat format);
-/*! @brief Copy data to/from \ref hipLibXtDesc_t descriptors.
+/*! @brief Copy data to/from \ref hipLibXtDesc descriptors.
*
- * Copy data according to the hipfftXtCopyType_t
+ * Copy data according to the hipfftXtCopyType
*
- * - ::HIPFFT_COPY_HOST_TO_DEVICE: dest points to a \ref hipLibXtDesc_t structure that describes multi-device memory layout. src points to a host memory buffer.
- * - ::HIPFFT_COPY_DEVICE_TO_HOST: src points to a \ref hipLibXtDesc_t structure that describes multi-device memory layout. dest points to a host memory buffer.
- * - ::HIPFFT_COPY_DEVICE_TO_DEVICE: Both dest and src point to a \ref hipLibXtDesc_t structure that describes multi-device memory layout. The two structures must describe memory with the same number of devices and memory sizes.
+ * - ::HIPFFT_COPY_HOST_TO_DEVICE: dest points to a \ref hipLibXtDesc structure that describes multi-device memory layout. src points to a host memory buffer.
+ * - ::HIPFFT_COPY_DEVICE_TO_HOST: src points to a \ref hipLibXtDesc structure that describes multi-device memory layout. dest points to a host memory buffer.
+ * - ::HIPFFT_COPY_DEVICE_TO_DEVICE: Both dest and src point to a \ref hipLibXtDesc structure that describes multi-device memory layout. The two structures must describe memory with the same number of devices and memory sizes.
*
* @param[in] plan Plan which has the descriptor.
* @param[out] dest Buffer that will be populated.
@@ -326,10 +326,10 @@ HIPFFT_EXPORT hipfftResult hipfftXtMemcpy(hipfftHandle plan,
*/
HIPFFT_EXPORT hipfftResult hipfftXtFree(hipLibXtDesc* desc);
-/** @defgroup hipfftXtExecDescriptor Execute FFTs using \ref hipLibXtDesc_t descriptors.
+/** @defgroup hipfftXtExecDescriptor Execute FFTs using \ref hipLibXtDesc descriptors.
*
- * Execute FFTs using \ref hipLibXtDesc_t descriptors. Inputs and
- * outputs are pointers to \ref hipLibXtDesc_t descriptors.
+ * Execute FFTs using \ref hipLibXtDesc descriptors. Inputs and
+ * outputs are pointers to \ref hipLibXtDesc descriptors.
* In-place transforms are performed by passing the same pointer for
* input and output.
*
diff --git a/library/include/hipfft/hiplibxt.h b/library/include/hipfft/hiplibxt.h
index 8014b99..38f3192 100644
--- a/library/include/hipfft/hiplibxt.h
+++ b/library/include/hipfft/hiplibxt.h
@@ -58,7 +58,7 @@ typedef enum hiplibFormat_t
/*! @struct hipLibXtDesc_t
* @brief Struct for single-process multi-GPU transform
*
- * This struct holds \ref hipXtDesc_t structures that define blocks
+ * This struct holds \ref hipXtDesc structures that define blocks
* of memory for use in a transform.
*
* @warning Experimental
|
