Skip to content

Fix Doxygen documentation build error in onnxruntime_c_api.h #27083

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yuslepukhin merged 2 commits into from
Jan 21, 2026
+10 −16
Merged

Fix Doxygen documentation build error in onnxruntime_c_api.h #27083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4569891
Fix Doxygen documentation build error in onnxruntime_c_api.h
nieubank Jan 20, 2026
40d363b
Fix Doxygen documentation build errors from recent PRs
nieubank Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions include/onnxruntime/core/session/onnxruntime_c_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -970,10 +970,6 @@ typedef OrtStatus*(ORT_API_CALL* RegisterCustomOpsFn)(OrtSessionOptions* options
*/
typedef void (*RunAsyncCallbackFn)(void* user_data, OrtValue** outputs, size_t num_outputs, OrtStatusPtr status);

/** \addtogroup Global
* @{
*/

/** \brief External memory handle type for importing GPU resources.
*
* \todo Add OPAQUE_WIN32 for Windows Vulkan-specific memory handles
Expand Down Expand Up @@ -1041,8 +1037,6 @@ typedef struct OrtExternalTensorDescriptor {
Enables multiple tensors from the same imported memory handle. */
} OrtExternalTensorDescriptor;

/// @}

/*
* Public enum for compiled model compatibility across EPs.
*/
Expand All @@ -1068,8 +1062,8 @@ typedef struct OrtEnvCreationOptions {
* \note Logging messages which are less severe than the `logging_severity_level` are not emitted.
*
* \note Serves as the default logging severity level for session creation and runs.
* Use ::SetSessionLogSeverityLevel() to set a logging severity level for the creation of specific session.
* Use ::RunOptionsSetRunLogSeverityLevel() to set a logging severity level for a specific session run.
* Use OrtApi::SetSessionLogSeverityLevel to set a logging severity level for the creation of specific session.
* Use OrtApi::RunOptionsSetRunLogSeverityLevel to set a logging severity level for a specific session run.
*
* \since Version 1.24.
*/
Expand Down Expand Up @@ -1122,7 +1116,7 @@ typedef struct OrtEnvCreationOptions {
* \note Refer to onnxruntime_env_config_keys.h for common config entry keys and their supported values.
*
* \note An application provides environment-level configuration options for execution provider libraries by
* using keys with the prefix 'ep_factory.<ep_name>.'. Ex: the key 'ep_factory.my_ep.some_ep_key' represents
* using keys with the prefix 'ep_factory.\\<ep_name\\>.'. Ex: the key 'ep_factory.my_ep.some_ep_key' represents
* a key named 'some_ep_key' that is meant to be consumed by an execution provider named 'my_ep'. Refer to
* the specific execution provider's documentation for valid keys and values.
*
Expand Down Expand Up @@ -7985,7 +7979,7 @@ struct OrtInteropApi {

/** \brief Release an OrtExternalResourceImporter instance.
*
* \param[in] importer The OrtExternalResourceImporter instance to release. May be nullptr.
* \param[in] input The OrtExternalResourceImporter instance to release. May be nullptr.
*
* \since Version 1.24.
*/
Expand Down Expand Up @@ -8028,7 +8022,7 @@ struct OrtInteropApi {

/** \brief Release an OrtExternalMemoryHandle instance.
*
* \param[in] handle The OrtExternalMemoryHandle instance to release. May be nullptr.
* \param[in] input The OrtExternalMemoryHandle instance to release. May be nullptr.
*
* \since Version 1.24.
*/
Expand Down Expand Up @@ -8094,7 +8088,7 @@ struct OrtInteropApi {

/** \brief Release an OrtExternalSemaphoreHandle instance.
*
* \param[in] handle The OrtExternalSemaphoreHandle instance to release. May be nullptr.
* \param[in] input The OrtExternalSemaphoreHandle instance to release. May be nullptr.
*
* \since Version 1.24.
*/
Expand Down
8 changes: 4 additions & 4 deletions include/onnxruntime/core/session/onnxruntime_ep_c_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -664,7 +664,7 @@ struct OrtLoopKernelHelper;
typedef struct OrtLoopKernelHelper OrtLoopKernelHelper;

/**
* \brief Contains helper functions for a Loop OrtKernelImpl created via ::CreateLoopKernel().
* \brief Contains helper functions for a Loop OrtKernelImpl created via OrtEpApi::CreateLoopKernel.
* \since Version 1.24.
*/
struct OrtLoopKernelHelper {
Expand Down Expand Up @@ -707,7 +707,7 @@ struct OrtScanKernelHelper;
typedef struct OrtScanKernelHelper OrtScanKernelHelper;

/**
* \brief Contains helper functions for a Scan OrtKernelImpl created via ::CreateScanKernel().
* \brief Contains helper functions for a Scan OrtKernelImpl created via OrtEpApi::CreateScanKernel.
* \since Version 1.24.
*/
struct OrtScanKernelHelper {
Expand Down Expand Up @@ -1431,13 +1431,13 @@ struct OrtEpApi {
/** \brief Gets a new OrtKeyValuePairs instance containing a copy of all configuration entries set on the environment.
*
* \note An application provides environment-level configuration options for execution provider libraries by
* using keys with the prefix 'ep_factory.<ep_name>.'. Ex: the key 'ep_factory.my_ep.some_ep_key' represents
* using keys with the prefix 'ep_factory.\\<ep_name\\>.'. Ex: the key 'ep_factory.my_ep.some_ep_key' represents
* a key named 'some_ep_key' that is meant to be consumed by an execution provider named 'my_ep'. Refer to
* the specific execution provider's documentation for valid keys and values.
*
* \note Refer to onnxruntime_env_config_keys.h for common configuration entry keys and their supported values.
*
* \param[out] out Output parameter set to the OrtKeyValuePairs instance containing all configuration entries.
* \param[out] config_entries Output parameter set to the OrtKeyValuePairs instance containing all configuration entries.
* Must be released via OrtApi::ReleaseKeyValuePairs.
*
* \snippet{doc} snippets.dox OrtStatus Return Value
Expand Down
Loading