Skip to content

Commit 74126d1

Browse files
Fix C/C++ documentation generation (microsoft#25112)
### Description Missed a few documentation errors in the [previous PR](microsoft#24887). This PR fixes the C/C++ API documentation generation action: https://github.com/microsoft/onnxruntime/actions/runs/15749541590 ### Motivation and Context Fix the C/C++ API documentation generation GitHub action.
1 parent 6413908 commit 74126d1

File tree

2 files changed

+18
-15
lines changed

2 files changed

+18
-15
lines changed

include/onnxruntime/core/session/onnxruntime_c_api.h

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5520,9 +5520,9 @@ struct OrtApi {
55205520
* Optionally returns the associated output index.
55215521
*
55225522
* \param[in] value_info The OrtValueInfo instance.
5523-
* \param[out] node Output parameter set to the OrtNode that produces the OrtValueInfo.
5524-
* \param[out] output_index Optional output parameter set to the OrtNode instance's output index
5525-
* that produces the value. Ignored if set to NULL.
5523+
* \param[out] producer_node Output parameter set to the OrtNode that produces the OrtValueInfo.
5524+
* \param[out] producer_output_index Optional output parameter set to the OrtNode instance's output index
5525+
* that produces the value. Ignored if set to NULL.
55265526
* \snippet{doc} snippets.dox OrtStatus Return Value
55275527
* \since Version 1.23.
55285528
*/
@@ -5539,7 +5539,9 @@ struct OrtApi {
55395539
*
55405540
* \param[in] value_info The OrtValueInfo instance.
55415541
* \param[out] num_consumers Output parameter set to the number of consumers of the value.
5542+
*
55425543
* \snippet{doc} snippets.dox OrtStatus Return Value
5544+
*
55435545
* \since Version 1.23.
55445546
*/
55455547
ORT_API2_STATUS(ValueInfo_GetValueNumConsumers, _In_ const OrtValueInfo* value_info, _Out_ size_t* num_consumers);
@@ -5597,7 +5599,7 @@ struct OrtApi {
55975599
* with the initializer serving as the default value.
55985600
*
55995601
* \param[in] value_info The OrtValueInfo instance representing the graph value.
5600-
* \param[out] Output parameter set to true if the graph value is a required graph input.
5602+
* \param[out] is_required_graph_input Output parameter set to true if the graph value is a required graph input.
56015603
*
56025604
* \snippet{doc} snippets.dox OrtStatus Return Value
56035605
*
@@ -5613,7 +5615,7 @@ struct OrtApi {
56135615
* The matching initializer is also known as a non-constant initializer.
56145616
*
56155617
* \param[in] value_info The OrtValueInfo instance representing the graph value.
5616-
* \param[out] Output parameter set to true if the graph value is an optional graph input.
5618+
* \param[out] is_optional_graph_input Output parameter set to true if the graph value is an optional graph input.
56175619
*
56185620
* \snippet{doc} snippets.dox OrtStatus Return Value
56195621
*
@@ -5625,7 +5627,7 @@ struct OrtApi {
56255627
/** \brief Returns a boolean indicating if the given value is a graph output.
56265628
*
56275629
* \param[in] value_info The OrtValueInfo instance representing the graph value.
5628-
* \param[out] Output parameter set to true if the graph value is a graph output.
5630+
* \param[out] is_graph_output Output parameter set to true if the graph value is a graph output.
56295631
*
56305632
* \snippet{doc} snippets.dox OrtStatus Return Value
56315633
*
@@ -5641,7 +5643,7 @@ struct OrtApi {
56415643
* constant initializer.
56425644
*
56435645
* \param[in] value_info The OrtValueInfo instance representing the graph value.
5644-
* \param[out] Output parameter set to true if the graph value is a constant initializer.
5646+
* \param[out] is_constant_initializer Output parameter set to true if the graph value is a constant initializer.
56455647
*
56465648
* \snippet{doc} snippets.dox OrtStatus Return Value
56475649
*
@@ -5656,7 +5658,8 @@ struct OrtApi {
56565658
* determining whether a value is defined in a parent node's graph.
56575659
*
56585660
* \param[in] value_info The OrtValueInfo instance representing the graph value.
5659-
* \param[out] Output parameter set to true if the value is defined in an outer scope (i.e., a parent graph).
5661+
* \param[out] is_from_outer_scope Output parameter set to true if the value is defined in an outer
5662+
* scope (i.e., a parent graph).
56605663
*
56615664
* \snippet{doc} snippets.dox OrtStatus Return Value
56625665
*
@@ -5672,7 +5675,7 @@ struct OrtApi {
56725675
/** \brief Returns a graph's name.
56735676
*
56745677
* \param[in] graph The OrtGraph instance.
5675-
* \param[out] Output parameter set to the graph's name.
5678+
* \param[out] graph_name Output parameter set to the graph's name.
56765679
*
56775680
* \snippet{doc} snippets.dox OrtStatus Return Value
56785681
*
@@ -5683,7 +5686,7 @@ struct OrtApi {
56835686
/** \brief Returns the ONNX IR version.
56845687
*
56855688
* \param[in] graph The OrtGraph instance.
5686-
* \param[out] Output parameter set to the ONNX IR version.
5689+
* \param[out] onnx_ir_version Output parameter set to the ONNX IR version.
56875690
*
56885691
* \snippet{doc} snippets.dox OrtStatus Return Value
56895692
*
@@ -5778,7 +5781,7 @@ struct OrtApi {
57785781
* (e.g., subgraphs contained by If and Loop nodes) may reuse identifiers.
57795782
*
57805783
* \param[in] node The OrtNode instance.
5781-
* \param[out] Output parameter set to the node's identifier.
5784+
* \param[out] node_id Output parameter set to the node's identifier.
57825785
*
57835786
* \snippet{doc} snippets.dox OrtStatus Return Value
57845787
*
@@ -5789,7 +5792,7 @@ struct OrtApi {
57895792
/** \brief Returns a node's name. Can be an empty string.
57905793
*
57915794
* \param[in] node The OrtNode instance.
5792-
* \param[out] Output parameter set to the node's name.
5795+
* \param[out] node_name Output parameter set to the node's name.
57935796
*
57945797
* \snippet{doc} snippets.dox OrtStatus Return Value
57955798
*
@@ -5800,7 +5803,7 @@ struct OrtApi {
58005803
/** \brief Returns a node's operator type (e.g., "Conv").
58015804
*
58025805
* \param[in] node The OrtNode instance.
5803-
* \param[out] Output parameter set to the name of the node's operator type.
5806+
* \param[out] operator_type Output parameter set to the name of the node's operator type.
58045807
*
58055808
* \snippet{doc} snippets.dox OrtStatus Return Value
58065809
*
@@ -5811,7 +5814,7 @@ struct OrtApi {
58115814
/** \brief Returns a node's domain name.
58125815
*
58135816
* \param[in] node The OrtNode instance.
5814-
* \param[out] Output parameter set to the node's domain name.
5817+
* \param[out] domain_name Output parameter set to the node's domain name.
58155818
*
58165819
* \snippet{doc} snippets.dox OrtStatus Return Value
58175820
*

include/onnxruntime/core/session/onnxruntime_ep_c_api.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ struct OrtEpApi {
106106
* \since Version 1.23.
107107
*/
108108
ORT_API2_STATUS(EpGraphSupportInfo_AddNodesToFuse, _In_ OrtEpGraphSupportInfo* graph_support_info,
109-
_In_reads_(num_nodes) const OrtNode* const* nodes, size_t num_nodes
109+
_In_reads_(num_nodes) const OrtNode* const* nodes, _In_ size_t num_nodes
110110
/*, OrtFusedNodeSchema* optional_fused_node_schema, OrtNodesToOptimizeInfo* nodes_to_opt*/);
111111

112112
/** \brief Specify a node that is supported by an OrtEp and should be run with a registered EP kernel.

0 commit comments

Comments
 (0)