3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-05-05 14:55:45 +00:00
z3/doc
2017-09-27 14:07:02 +03:00
..
CMakeLists.txt
mk_api_doc.py fix pydoc part of make api_docs 2017-09-27 14:07:02 +03:00
README
update_api_website.cmd
update_code_website.cmd
website.dox.in
z3api.cfg.in
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'