mirrors/z3
3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-04-27 10:55:50 +00:00
Code Activity
z3/doc
History
Nikolaj Bjorner b5a89eb4ab add missing generation of z3.z3 for pydoc and add some explanations to logging function declaration
2022-07-17 11:03:55 -07:00
..
CMakeLists.txt align readme-cmake and cmakelists.txt according to current state #2732 2019-11-23 15:59:16 -08:00
design_recfuns.md wip: add recursive functions 2017-12-25 22:51:39 +01:00
mk_api_doc.py add missing generation of z3.z3 for pydoc and add some explanations to logging function declaration 2022-07-17 11:03:55 -07:00
README Clean up README 2016-03-23 16:14:38 +01:00
website.dox.in remove space 2022-07-11 20:33:12 -07:00
z3api.cfg.in doc macros 2022-03-03 14:59:38 -08:00
z3code.dox doc macros 2022-03-03 14:59:38 -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'