Skip to content

Commit 502bc7e

Browse files
committed
UCP/API: fix Doxygen unresolved @ref for estimated_bw struct members
Use @A instead of @ref for local_mem_type, remote_mem_type, and bandwidth since they are fields inside a nested anonymous struct and cannot be resolved by Doxygen as cross-references.
1 parent f18d06a commit 502bc7e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/ucp/api/ucp.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4272,9 +4272,9 @@ typedef struct ucp_ep_attr {
42724272

42734273
/**
42744274
* Estimated bandwidth (in bytes/second) for a given pair of local and
4275-
* remote memory types. The caller sets @ref local_mem_type and
4276-
* @ref remote_mem_type before calling @ref ucp_ep_query, and the
4277-
* implementation fills in @ref bandwidth with the aggregate estimated
4275+
* remote memory types. The caller sets @a local_mem_type and
4276+
* @a remote_mem_type before calling @ref ucp_ep_query, and the
4277+
* implementation fills in @a bandwidth with the aggregate estimated
42784278
* bandwidth across the endpoint's data lanes that support the requested
42794279
* memory types.
42804280
*/

0 commit comments

Comments
 (0)