3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-07-18 10:30:44 +00:00
z3/doc
Christoph M. Wintersteiger c3c06d756c Documentation fixes.
2017-12-18 20:12:19 +00:00
..
CMakeLists.txt [CMake] When invoking mk_api_doc.py pass the build directory. 2017-11-13 22:31:05 +00:00
mk_api_doc.py Documentation fixes. 2017-12-18 20:12:19 +00:00
README
update_api_website.cmd
update_code_website.cmd
website.dox.in doc fixes 2017-07-09 11:26:27 +02:00
z3api.cfg.in [Doxygen] Fix bug where some header files were not being scanned. 2017-06-07 17:09:01 +01:00
z3code.dox

API documentation
-----------------

To generate the API documentation for the C, C++, .NET, Java and Python APIs, we must execute

   python mk_api_doc.py

We must have doxygen installed in our system.

The documentation will be stored in the subdirectory './api/html'.
The main file is './api/html/index.html'

Code documentation
------------------

To generate documentation for the Z3 code, we must execute

   doxygen z3code.dox

We must also have dot installed in our system.

The documentation will be store in the subdirectory './code/html'.
The main file is './code/html/index.html'