3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-04-06 17:44:08 +00:00
z3/doc
2017-09-27 14:07:18 +03:00
..
CMakeLists.txt [CMake] Move CMake files into their intended location so the 2017-06-12 11:59:00 +01:00
mk_api_doc.py fix Python API doxygen (make api_docs) 2017-09-27 14:07:18 +03:00
README Clean up README 2016-03-23 16:14:38 +01:00
update_api_website.cmd improved Z3 documentation 2012-11-22 17:09:30 -08:00
update_code_website.cmd updated API doc generation 2012-11-22 18:16:58 -08:00
website.dox.in doc fixes 2017-07-09 11:26:27 +02:00
z3api.cfg.in [Doxygen] Fix bug where some header files were not being scanned. 2017-06-07 17:09:01 +01: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'