z3/doc
Lu zhiping 65307b9f12 Import Upstream version 4.8.7 2022-08-15 16:26:39 +08:00
..
CMakeLists.txt Import Upstream version 4.8.7 2022-08-15 16:26:39 +08:00
README Import Upstream version 4.8.7 2022-08-15 16:26:39 +08:00
design_recfuns.md Import Upstream version 4.8.7 2022-08-15 16:26:39 +08:00
mk_api_doc.py Import Upstream version 4.8.7 2022-08-15 16:26:39 +08:00
website.dox.in Import Upstream version 4.8.7 2022-08-15 16:26:39 +08:00
z3api.cfg.in Import Upstream version 4.8.7 2022-08-15 16:26:39 +08:00
z3code.dox Import Upstream version 4.8.7 2022-08-15 16:26:39 +08:00

README

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'