diff --git a/.github/workflows/publish-c-apidocs.yml b/.github/workflows/publish-c-apidocs.yml index 51378cfa5b87f..487336428ad3b 100644 --- a/.github/workflows/publish-c-apidocs.yml +++ b/.github/workflows/publish-c-apidocs.yml @@ -3,6 +3,10 @@ on: push: branches: - main + paths: + - include/onnxruntime/core/session + + workflow_dispatch: jobs: publish: @@ -13,10 +17,10 @@ jobs: - name: Install doxygen and dependencies run: | sudo apt update - sudo apt-get install libclang-9-dev - sudo apt-get install libclang-cpp9 - wget https://www.doxygen.nl/files/doxygen-1.9.2.linux.bin.tar.gz - tar xvzf doxygen-1.9.2.linux.bin.tar.gz + sudo apt-get install libclang-dev + sudo apt-get install libclang-cpp14 + wget https://www.doxygen.nl/files/doxygen-1.9.6.linux.bin.tar.gz + tar xvzf doxygen-1.9.6.linux.bin.tar.gz - name: Set commit ID id: vars run: echo "::set-output name=sha_short::$(git rev-parse --short HEAD)" @@ -24,7 +28,7 @@ jobs: run: | mkdir -p build/doxygen cd docs/c_cxx - ../../doxygen-1.9.2/bin/doxygen + ../../doxygen-1.9.6/bin/doxygen - uses: actions/checkout@v2 with: ref: gh-pages @@ -36,7 +40,7 @@ jobs: - name: Create Pull Request uses: peter-evans/create-pull-request@v3 with: - branch: gh-pages-pr + branch: gh-pages-pr-c-docs base: gh-pages title: '[Automated]: Update C/C++ API docs' commit-message: 'Update C/C++ API docs to commit ${{ steps.vars.outputs.sha_short }}' diff --git a/docs/c_cxx/Doxyfile b/docs/c_cxx/Doxyfile index 888e0a36b34b2..aa59e5be1a8e1 100644 --- a/docs/c_cxx/Doxyfile +++ b/docs/c_cxx/Doxyfile @@ -1654,17 +1654,6 @@ HTML_FORMULA_FORMAT = png FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANSPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands # to create new LaTeX commands to be used in formulas as building blocks. See # the section "Including formulas" for details. @@ -2352,15 +2341,6 @@ EXTERNAL_PAGES = YES # Configuration options related to the dot tool #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram -# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to -# NO turns the diagrams off. Note that this option also works with HAVE_DOT -# disabled, but it is recommended to install and use dot, since it yields more -# powerful graphs. -# The default value is: YES. - -CLASS_DIAGRAMS = NO - # You can include diagrams made with dia in doxygen documentation. Doxygen will # then run dia to produce the diagram and insert it in the documentation. The # DIA_PATH tag allows you to specify the directory where the dia binary resides. @@ -2393,23 +2373,6 @@ HAVE_DOT = NO DOT_NUM_THREADS = 0 -# When you want a differently looking font in the dot files that doxygen -# generates you can specify the font name using DOT_FONTNAME. You need to make -# sure dot is able to find the font, which can be done by putting it in a -# standard location or by setting the DOTFONTPATH environment variable or by -# setting DOT_FONTPATH to the directory containing the font. -# The default value is: Helvetica. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTNAME = Helvetica - -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of -# dot graphs. -# Minimum value: 4, maximum value: 24, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTSIZE = 10 - # By default doxygen will tell dot to use the default font as specified with # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set # the path where dot can find it using this tag. @@ -2644,18 +2607,6 @@ DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not seem -# to support this out of the box. -# -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_TRANSPARENT = NO - # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) support diff --git a/docs/c_cxx/doxygen-header.html b/docs/c_cxx/doxygen-header.html index cd2171adadc75..364f76f7f0580 100644 --- a/docs/c_cxx/doxygen-header.html +++ b/docs/c_cxx/doxygen-header.html @@ -1,4 +1,4 @@ - + diff --git a/include/onnxruntime/core/session/onnxruntime_c_api.h b/include/onnxruntime/core/session/onnxruntime_c_api.h index 37aa6a7cd87b0..bd9eb64ae840e 100644 --- a/include/onnxruntime/core/session/onnxruntime_c_api.h +++ b/include/onnxruntime/core/session/onnxruntime_c_api.h @@ -3703,7 +3703,6 @@ struct OrtApi { ORT_API2_STATUS(RegisterCustomOpsUsingFunction, _Inout_ OrtSessionOptions* options, _In_ const char* registration_func_name); - /// @} /// \name OrtKernelInfo /// Custom operator APIs. /// @{ @@ -3795,6 +3794,7 @@ struct OrtApi { * of an input during kernel/session creation. * * \param[in] info An instance of ::OrtKernelInfo. + * \param[in] index Which input to get the type information for * \param[out] type_info Pointer set to the resulting ::OrtTypeInfo. Must be freed with OrtApi::ReleaseTypeInfo. * * \snippet{doc} snippets.dox OrtStatus Return Value @@ -3809,6 +3809,7 @@ struct OrtApi { * of an output during kernel/session creation. * * \param[in] info An instance of ::OrtKernelInfo. + * \param[in] index Which input to get the type information for * \param[out] type_info Pointer set to the resulting ::OrtTypeInfo. Must be freed with OrtApi::ReleaseTypeInfo. * * \snippet{doc} snippets.dox OrtStatus Return Value @@ -3893,7 +3894,7 @@ struct OrtApi { * If oneDNN is not available, this function will return failure. * * \param[in] options - * \param[in] cann_options + * \param[in] dnnl_options * * \snippet{doc} snippets.dox OrtStatus Return Value *