3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-04-05 17:14:07 +00:00
z3/doc
Nikolaj Bjorner b169292743 add parameter descriptions
Signed-off-by: Nikolaj Bjorner <nbjorner@microsoft.com>
2022-08-16 08:26:53 -07:00
..
CMakeLists.txt cmake: Cleanup remnants of workaround for USES_TERMINAL. 2022-08-02 17:39:10 +03:00
design_recfuns.md wip: add recursive functions 2017-12-25 22:51:39 +01:00
mk_api_doc.py add parameter descriptions 2022-08-16 08:26:53 -07:00
README Clean up README 2016-03-23 16:14:38 +01:00
website.dox.in Fix warning about \ref when building website.dox 2022-08-01 18:51:20 +03:00
z3api.cfg.in Remove remaining references to Z3_bool_opt. 2022-07-30 05:48:27 +02:00
z3code.dox Remove remaining references to Z3_bool_opt. 2022-07-30 05:48:27 +02:00

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'