onnxruntime/docs/c_cxx
2021-12-10 17:45:50 -08:00
..
Doxyfile Automate generation of C/C++ API docs (#9997) 2021-12-10 17:45:50 -08:00
doxygen-header.html Fix S360 issue by using "use strict" for javascript code. (#9128) 2021-09-20 20:32:44 -07:00
README.md

How to build the Doxygen HTML pages on Windows:

  • Install Doxygen (https://www.doxygen.nl/download.html)
  • Running from the command line:
    • cd to (Repository Root)\docs\c_cxx
    • Run "\Program Files\doxygen\bin\doxygen.exe" Doxyfile
  • Using the Doxygen GUI app:
    • Launch Doxygen GUI (Doxywizard)
    • File->Open (Repository Root)\docs\c_cxx\Doxyfile
    • Switch to Run tab, click 'Run doxygen'
  • Generated docs are written to (Repository Root)\build\doxygen\html

The generated documentation is online in the gh-pages branch of the project: https://github.com/microsoft/onnxruntime/tree/gh-pages/docs/api/c