3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-10-21 14:50:32 +00:00
z3/doc
Nikolaj Bjorner e6f8fe359e remove empty file
Signed-off-by: Nikolaj Bjorner <nbjorner@microsoft.com>
2023-01-31 12:32:28 -08:00
..
CMakeLists.txt
design_recfuns.md
mk_api_doc.py finish parameter help 2022-08-16 08:29:24 -07:00
mk_params_doc.py include global parameters and fixup for HTML meta-characters 2022-08-22 14:25:18 -07:00
mk_tactic_doc.py remove empty file 2023-01-31 12:32:28 -08:00
README
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'