3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-04-06 09:34:08 +00:00
z3/doc
Nikolaj Bjorner 5cbabb20ac align readme-cmake and cmakelists.txt according to current state #2732
Signed-off-by: Nikolaj Bjorner <nbjorner@microsoft.com>
2019-11-23 15:59:16 -08: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 Fix "Unbound module Z" error when invoking ocamldoc. 2019-11-21 16:04:17 -08:00
README Clean up README 2016-03-23 16:14:38 +01:00
website.dox.in doc fixes 2017-07-09 11:26:27 +02:00
z3api.cfg.in Fix some spelling errors (mostly in comments). 2018-10-20 17:07:41 +02:00
z3code.dox C API cleanup. Mainly removal of ML-specific macros that are not used anymore and inline documentation fixes. 2015-12-03 17:33:25 +00: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'