3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2026-03-17 18:43:45 +00:00
z3/doc
Nikolaj Bjorner 4953b95baa cleanup pre-processor for z3_api.h
Signed-off-by: Nikolaj Bjorner <nbjorner@microsoft.com>
2022-05-28 12:19:39 -07:00
..
CMakeLists.txt
design_recfuns.md
mk_api_doc.py cleanup pre-processor for z3_api.h 2022-05-28 12:19:39 -07:00
README
website.dox.in fix a tiny typo (#5960) 2022-04-11 08:40:03 +02:00
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'