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
|
# ONNX Runtime C/C++ docs source files
This directory contains doxygen configuration to generate the C/C++ API docs for ONNX Runtime.
The actual generation is performed by a GitHub actions workflow: [publish-c-apidocs.yml](../../.github/workflows/publish-c-apidocs.yml).
The workflow is currently manually triggered, and generates a PR to the gh-pages branch, for publication on https://onnxruntime.ai.
# C/C++ API Documentation Conventions
## Handling API changes across versions
When a new API is added or an existing API is changed, indicate this in the API's documentation with the Doxygen `\since` command.
This lets readers know the availability and behavior in different versions.
For a new API in version X, add `\since Version X.`. If an API's behavior changes in version Y, add `\since Version Y: <change description>`.
Put each API change entry for a version on its own line.
For example:
```c++
/**
* \brief My API function.
* \since Version X.
* \since Version Y: Does things differently.
*/
void MyApi();
```
|
