saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-05-14 20:48:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
onnxruntime/objectivec/docs
History
Edward Chen e22b0836e7
[objc] Update docs and fix static analysis build (#16617) 
- Update some documentation comments.
- Use onnxruntime_training.h as the umbrella header so training API docs are included in generated docs.
- Fix static analysis build.
2023-07-07 07:58:54 -07:00
..
jazzy_config.yaml [objc] Update docs and fix static analysis build (#16617) 2023-07-07 07:58:54 -07:00
main_page.md
readme.md

readme.md

Objective-C API Documentation

The API should be documented with comments in the public header files.

Documentation Generation

The Jazzy tool is used to generate documentation from the code.

To generate documentation, from the repo root, run:

jazzy --config objectivec/docs/jazzy_config.yaml --output <output directory>

The generated documentation website files will be in <output directory>.

main_page.md contains content for the main page of the generated documentation website.